Fix Doxygen misuse: refer to parameter names in paragraphs correctly (\arg is

not what most people want -- it starts a new paragraph).

llvm-svn: 163793
This commit is contained in:
Dmitri Gribenko 2012-09-13 13:11:20 +00:00
parent 024e075597
commit 8994e0c03d
26 changed files with 99 additions and 105 deletions

View File

@ -383,7 +383,7 @@ CINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1,
CXSourceRange range2); CXSourceRange range2);
/** /**
* \brief Returns non-zero if \arg range is null. * \brief Returns non-zero if \p range is null.
*/ */
CINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range); CINDEX_LINKAGE int clang_Range_isNull(CXSourceRange range);
@ -2069,9 +2069,9 @@ CINDEX_LINKAGE CXCursor clang_getTranslationUnitCursor(CXTranslationUnit);
CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor); CINDEX_LINKAGE unsigned clang_equalCursors(CXCursor, CXCursor);
/** /**
* \brief Returns non-zero if \arg cursor is null. * \brief Returns non-zero if \p cursor is null.
*/ */
CINDEX_LINKAGE int clang_Cursor_isNull(CXCursor); CINDEX_LINKAGE int clang_Cursor_isNull(CXCursor cursor);
/** /**
* \brief Compute a hash value for the given cursor. * \brief Compute a hash value for the given cursor.

View File

@ -51,7 +51,7 @@ bool applyTransformations(CompilerInvocation &origCI,
DiagnosticConsumer *DiagClient); DiagnosticConsumer *DiagClient);
/// \brief Applies automatic modifications and produces temporary files /// \brief Applies automatic modifications and produces temporary files
/// and metadata into the \arg outputDir path. /// and metadata into the \p outputDir path.
/// ///
/// \param emitPremigrationARCErrors if true all ARC errors will get emitted /// \param emitPremigrationARCErrors if true all ARC errors will get emitted
/// even if the migrator can fix them, but the function will still return false /// even if the migrator can fix them, but the function will still return false
@ -68,7 +68,7 @@ bool migrateWithTemporaryFiles(CompilerInvocation &origCI,
bool emitPremigrationARCErrors, bool emitPremigrationARCErrors,
StringRef plistOut); StringRef plistOut);
/// \brief Get the set of file remappings from the \arg outputDir path that /// \brief Get the set of file remappings from the \p outputDir path that
/// migrateWithTemporaryFiles produced. /// migrateWithTemporaryFiles produced.
/// ///
/// \returns false if no error is produced, true otherwise. /// \returns false if no error is produced, true otherwise.

View File

@ -1325,8 +1325,8 @@ public:
/// for some targets. /// for some targets.
QualType getVaListTagType() const; QualType getVaListTagType() const;
/// \brief Return a type with additional \c const, \c volatile, or \crestrict /// \brief Return a type with additional \c const, \c volatile, or
/// qualifiers. /// \c restrict qualifiers.
QualType getCVRQualifiedType(QualType T, unsigned CVR) const { QualType getCVRQualifiedType(QualType T, unsigned CVR) const {
return getQualifiedType(T, Qualifiers::fromCVRMask(CVR)); return getQualifiedType(T, Qualifiers::fromCVRMask(CVR));
} }
@ -1756,8 +1756,8 @@ public:
/// \brief Return a real floating point or a complex type (based on /// \brief Return a real floating point or a complex type (based on
/// \p typeDomain/\p typeSize). /// \p typeDomain/\p typeSize).
/// ///
/// \arg typeDomain a real floating point or complex type. /// \param typeDomain a real floating point or complex type.
/// \arg typeSize a real floating point or complex type. /// \param typeSize a real floating point or complex type.
QualType getFloatingTypeOfSizeWithinDomain(QualType typeSize, QualType getFloatingTypeOfSizeWithinDomain(QualType typeSize,
QualType typeDomain) const; QualType typeDomain) const;

View File

@ -164,8 +164,8 @@ namespace clang {
QuantityType getQuantity() const { return Quantity; } QuantityType getQuantity() const { return Quantity; }
/// RoundUpToAlignment - Returns the next integer (mod 2**64) that is /// RoundUpToAlignment - Returns the next integer (mod 2**64) that is
/// greater than or equal to this quantity and is a multiple of \arg /// greater than or equal to this quantity and is a multiple of \p Align.
/// Align. Align must be non-zero. /// Align must be non-zero.
CharUnits RoundUpToAlignment(const CharUnits &Align) { CharUnits RoundUpToAlignment(const CharUnits &Align) {
return CharUnits(llvm::RoundUpToAlignment(Quantity, return CharUnits(llvm::RoundUpToAlignment(Quantity,
Align.Quantity)); Align.Quantity));

View File

@ -712,7 +712,7 @@ public:
typedef clang::StorageClass StorageClass; typedef clang::StorageClass StorageClass;
/// getStorageClassSpecifierString - Return the string used to /// getStorageClassSpecifierString - Return the string used to
/// specify the storage class \arg SC. /// specify the storage class \p SC.
/// ///
/// It is illegal to call this function with SC == None. /// It is illegal to call this function with SC == None.
static const char *getStorageClassSpecifierString(StorageClass SC); static const char *getStorageClassSpecifierString(StorageClass SC);

View File

@ -363,7 +363,7 @@ public:
} }
/// \brief Sets the method's parameters and selector source locations. /// \brief Sets the method's parameters and selector source locations.
/// If the method is implicit (not coming from source) \arg SelLocs is /// If the method is implicit (not coming from source) \p SelLocs is
/// ignored. /// ignored.
void setMethodParams(ASTContext &C, void setMethodParams(ASTContext &C,
ArrayRef<ParmVarDecl*> Params, ArrayRef<ParmVarDecl*> Params,

View File

@ -162,7 +162,7 @@ public:
} }
/// \brief Get the decls that are contained in a file in the Offset/Length /// \brief Get the decls that are contained in a file in the Offset/Length
/// range. \arg Length can be 0 to indicate a point at \arg Offset instead of /// range. \p Length can be 0 to indicate a point at \p Offset instead of
/// a range. /// a range.
virtual void FindFileRegionDecls(FileID File, unsigned Offset,unsigned Length, virtual void FindFileRegionDecls(FileID File, unsigned Offset,unsigned Length,
SmallVectorImpl<Decl *> &Decls) {} SmallVectorImpl<Decl *> &Decls) {}

View File

@ -83,7 +83,7 @@ public:
/// \brief The Objective-C NSArray selectors. /// \brief The Objective-C NSArray selectors.
Selector getNSArraySelector(NSArrayMethodKind MK) const; Selector getNSArraySelector(NSArrayMethodKind MK) const;
/// \brief Return NSArrayMethodKind if \arg Sel is such a selector. /// \brief Return NSArrayMethodKind if \p Sel is such a selector.
llvm::Optional<NSArrayMethodKind> getNSArrayMethodKind(Selector Sel); llvm::Optional<NSArrayMethodKind> getNSArrayMethodKind(Selector Sel);
/// \brief Enumerates the NSDictionary methods used to generate literals. /// \brief Enumerates the NSDictionary methods used to generate literals.
@ -104,7 +104,7 @@ public:
/// \brief The Objective-C NSDictionary selectors. /// \brief The Objective-C NSDictionary selectors.
Selector getNSDictionarySelector(NSDictionaryMethodKind MK) const; Selector getNSDictionarySelector(NSDictionaryMethodKind MK) const;
/// \brief Return NSDictionaryMethodKind if \arg Sel is such a selector. /// \brief Return NSDictionaryMethodKind if \p Sel is such a selector.
llvm::Optional<NSDictionaryMethodKind> llvm::Optional<NSDictionaryMethodKind>
getNSDictionaryMethodKind(Selector Sel); getNSDictionaryMethodKind(Selector Sel);
@ -169,7 +169,7 @@ public:
Sel == getNSNumberLiteralSelector(MK, true); Sel == getNSNumberLiteralSelector(MK, true);
} }
/// \brief Return NSNumberLiteralMethodKind if \arg Sel is such a selector. /// \brief Return NSNumberLiteralMethodKind if \p Sel is such a selector.
llvm::Optional<NSNumberLiteralMethodKind> llvm::Optional<NSNumberLiteralMethodKind>
getNSNumberLiteralMethodKind(Selector Sel) const; getNSNumberLiteralMethodKind(Selector Sel) const;

View File

@ -42,7 +42,7 @@ enum SelectorLocationsKind {
SelLoc_StandardWithSpace = 2 SelLoc_StandardWithSpace = 2
}; };
/// \brief Returns true if all \arg SelLocs are in a "standard" location. /// \brief Returns true if all \p SelLocs are in a "standard" location.
SelectorLocationsKind hasStandardSelectorLocs(Selector Sel, SelectorLocationsKind hasStandardSelectorLocs(Selector Sel,
ArrayRef<SourceLocation> SelLocs, ArrayRef<SourceLocation> SelLocs,
ArrayRef<Expr *> Args, ArrayRef<Expr *> Args,
@ -60,7 +60,7 @@ SourceLocation getStandardSelectorLoc(unsigned Index,
ArrayRef<Expr *> Args, ArrayRef<Expr *> Args,
SourceLocation EndLoc); SourceLocation EndLoc);
/// \brief Returns true if all \arg SelLocs are in a "standard" location. /// \brief Returns true if all \p SelLocs are in a "standard" location.
SelectorLocationsKind hasStandardSelectorLocs(Selector Sel, SelectorLocationsKind hasStandardSelectorLocs(Selector Sel,
ArrayRef<SourceLocation> SelLocs, ArrayRef<SourceLocation> SelLocs,
ArrayRef<ParmVarDecl *> Args, ArrayRef<ParmVarDecl *> Args,

View File

@ -30,7 +30,7 @@ private:
bool OwnsVMContext; bool OwnsVMContext;
protected: protected:
/// Create a new code generation action. If the optional \arg _VMContext /// Create a new code generation action. If the optional \p _VMContext
/// parameter is supplied, the action uses it without taking ownership, /// parameter is supplied, the action uses it without taking ownership,
/// otherwise it creates a fresh LLVM context and takes ownership. /// otherwise it creates a fresh LLVM context and takes ownership.
CodeGenAction(unsigned _Act, llvm::LLVMContext *_VMContext = 0); CodeGenAction(unsigned _Act, llvm::LLVMContext *_VMContext = 0);

View File

@ -117,7 +117,7 @@ namespace driver {
/// @name Arg Access /// @name Arg Access
/// @{ /// @{
/// append - Append \arg A to the arg list. /// append - Append \p A to the arg list.
void append(Arg *A); void append(Arg *A);
arglist_type &getArgs() { return Args; } arglist_type &getArgs() { return Args; }
@ -153,16 +153,16 @@ namespace driver {
/// @name Arg Removal /// @name Arg Removal
/// @{ /// @{
/// eraseArg - Remove any option matching \arg Id. /// eraseArg - Remove any option matching \p Id.
void eraseArg(OptSpecifier Id); void eraseArg(OptSpecifier Id);
/// @} /// @}
/// @name Arg Access /// @name Arg Access
/// @{ /// @{
/// hasArg - Does the arg list contain any option matching \arg Id. /// hasArg - Does the arg list contain any option matching \p Id.
/// ///
/// \arg Claim Whether the argument should be claimed, if it exists. /// \p Claim Whether the argument should be claimed, if it exists.
bool hasArgNoClaim(OptSpecifier Id) const { bool hasArgNoClaim(OptSpecifier Id) const {
return getLastArgNoClaim(Id) != 0; return getLastArgNoClaim(Id) != 0;
} }
@ -176,9 +176,9 @@ namespace driver {
return getLastArg(Id0, Id1, Id2) != 0; return getLastArg(Id0, Id1, Id2) != 0;
} }
/// getLastArg - Return the last argument matching \arg Id, or null. /// getLastArg - Return the last argument matching \p Id, or null.
/// ///
/// \arg Claim Whether the argument should be claimed, if it exists. /// \p Claim Whether the argument should be claimed, if it exists.
Arg *getLastArgNoClaim(OptSpecifier Id) const; Arg *getLastArgNoClaim(OptSpecifier Id) const;
Arg *getLastArg(OptSpecifier Id) const; Arg *getLastArg(OptSpecifier Id) const;
Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1) const; Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1) const;
@ -196,7 +196,7 @@ namespace driver {
OptSpecifier Id3, OptSpecifier Id4, OptSpecifier Id5, OptSpecifier Id3, OptSpecifier Id4, OptSpecifier Id5,
OptSpecifier Id6, OptSpecifier Id7) const; OptSpecifier Id6, OptSpecifier Id7) const;
/// getArgString - Return the input argument string at \arg Index. /// getArgString - Return the input argument string at \p Index.
virtual const char *getArgString(unsigned Index) const = 0; virtual const char *getArgString(unsigned Index) const = 0;
/// getNumInputArgStrings - Return the number of original argument strings, /// getNumInputArgStrings - Return the number of original argument strings,
@ -233,15 +233,13 @@ namespace driver {
/// @name Translation Utilities /// @name Translation Utilities
/// @{ /// @{
/// hasFlag - Given an option \arg Pos and its negative form \arg /// hasFlag - Given an option \p Pos and its negative form \p Neg, return
/// Neg, return true if the option is present, false if the /// true if the option is present, false if the negation is present, and
/// negation is present, and \arg Default if neither option is /// \p Default if neither option is given. If both the option and its
/// given. If both the option and its negation are present, the /// negation are present, the last one wins.
/// last one wins.
bool hasFlag(OptSpecifier Pos, OptSpecifier Neg, bool Default=true) const; bool hasFlag(OptSpecifier Pos, OptSpecifier Neg, bool Default=true) const;
/// AddLastArg - Render only the last argument match \arg Id0, if /// AddLastArg - Render only the last argument match \p Id0, if present.
/// present.
void AddLastArg(ArgStringList &Output, OptSpecifier Id0) const; void AddLastArg(ArgStringList &Output, OptSpecifier Id0) const;
/// AddAllArgs - Render all arguments matching the given ids. /// AddAllArgs - Render all arguments matching the given ids.
@ -286,8 +284,8 @@ namespace driver {
} }
const char *MakeArgString(const Twine &Str) const; const char *MakeArgString(const Twine &Str) const;
/// \brief Create an arg string for (\arg LHS + \arg RHS), reusing the /// \brief Create an arg string for (\p LHS + \p RHS), reusing the
/// string at \arg Index if possible. /// string at \p Index if possible.
const char *GetOrMakeJoinedArgString(unsigned Index, StringRef LHS, const char *GetOrMakeJoinedArgString(unsigned Index, StringRef LHS,
StringRef RHS) const; StringRef RHS) const;
@ -347,7 +345,7 @@ namespace driver {
mutable arglist_type SynthesizedArgs; mutable arglist_type SynthesizedArgs;
public: public:
/// Construct a new derived arg list from \arg BaseArgs. /// Construct a new derived arg list from \p BaseArgs.
DerivedArgList(const InputArgList &BaseArgs); DerivedArgList(const InputArgList &BaseArgs);
~DerivedArgList(); ~DerivedArgList();
@ -374,14 +372,14 @@ namespace driver {
virtual const char *MakeArgString(StringRef Str) const; virtual const char *MakeArgString(StringRef Str) const;
/// AddFlagArg - Construct a new FlagArg for the given option \arg Id and /// AddFlagArg - Construct a new FlagArg for the given option \p Id and
/// append it to the argument list. /// append it to the argument list.
void AddFlagArg(const Arg *BaseArg, const Option *Opt) { void AddFlagArg(const Arg *BaseArg, const Option *Opt) {
append(MakeFlagArg(BaseArg, Opt)); append(MakeFlagArg(BaseArg, Opt));
} }
/// AddPositionalArg - Construct a new Positional arg for the given option /// AddPositionalArg - Construct a new Positional arg for the given option
/// \arg Id, with the provided \arg Value and append it to the argument /// \p Id, with the provided \p Value and append it to the argument
/// list. /// list.
void AddPositionalArg(const Arg *BaseArg, const Option *Opt, void AddPositionalArg(const Arg *BaseArg, const Option *Opt,
StringRef Value) { StringRef Value) {
@ -390,7 +388,7 @@ namespace driver {
/// AddSeparateArg - Construct a new Positional arg for the given option /// AddSeparateArg - Construct a new Positional arg for the given option
/// \arg Id, with the provided \arg Value and append it to the argument /// \p Id, with the provided \p Value and append it to the argument
/// list. /// list.
void AddSeparateArg(const Arg *BaseArg, const Option *Opt, void AddSeparateArg(const Arg *BaseArg, const Option *Opt,
StringRef Value) { StringRef Value) {
@ -398,30 +396,29 @@ namespace driver {
} }
/// AddJoinedArg - Construct a new Positional arg for the given option \arg /// AddJoinedArg - Construct a new Positional arg for the given option
/// Id, with the provided \arg Value and append it to the argument list. /// \p Id, with the provided \p Value and append it to the argument list.
void AddJoinedArg(const Arg *BaseArg, const Option *Opt, void AddJoinedArg(const Arg *BaseArg, const Option *Opt,
StringRef Value) { StringRef Value) {
append(MakeJoinedArg(BaseArg, Opt, Value)); append(MakeJoinedArg(BaseArg, Opt, Value));
} }
/// MakeFlagArg - Construct a new FlagArg for the given option /// MakeFlagArg - Construct a new FlagArg for the given option \p Id.
/// \arg Id.
Arg *MakeFlagArg(const Arg *BaseArg, const Option *Opt) const; Arg *MakeFlagArg(const Arg *BaseArg, const Option *Opt) const;
/// MakePositionalArg - Construct a new Positional arg for the /// MakePositionalArg - Construct a new Positional arg for the
/// given option \arg Id, with the provided \arg Value. /// given option \p Id, with the provided \p Value.
Arg *MakePositionalArg(const Arg *BaseArg, const Option *Opt, Arg *MakePositionalArg(const Arg *BaseArg, const Option *Opt,
StringRef Value) const; StringRef Value) const;
/// MakeSeparateArg - Construct a new Positional arg for the /// MakeSeparateArg - Construct a new Positional arg for the
/// given option \arg Id, with the provided \arg Value. /// given option \p Id, with the provided \p Value.
Arg *MakeSeparateArg(const Arg *BaseArg, const Option *Opt, Arg *MakeSeparateArg(const Arg *BaseArg, const Option *Opt,
StringRef Value) const; StringRef Value) const;
/// MakeJoinedArg - Construct a new Positional arg for the /// MakeJoinedArg - Construct a new Positional arg for the
/// given option \arg Id, with the provided \arg Value. /// given option \p Id, with the provided \p Value.
Arg *MakeJoinedArg(const Arg *BaseArg, const Option *Opt, Arg *MakeJoinedArg(const Arg *BaseArg, const Option *Opt,
StringRef Value) const; StringRef Value) const;

View File

@ -98,8 +98,7 @@ public:
StringRef getSysRoot() const; StringRef getSysRoot() const;
/// getArgsForToolChain - Return the derived argument list for the /// getArgsForToolChain - Return the derived argument list for the
/// tool chain \arg TC (or the default tool chain, if TC is not /// tool chain \p TC (or the default tool chain, if TC is not specified).
/// specified).
/// ///
/// \param BoundArch - The bound architecture name, or 0. /// \param BoundArch - The bound architecture name, or 0.
const DerivedArgList &getArgsForToolChain(const ToolChain *TC, const DerivedArgList &getArgsForToolChain(const ToolChain *TC,

View File

@ -287,7 +287,7 @@ public:
/// BuildJobs - Bind actions to concrete tools and translate /// BuildJobs - Bind actions to concrete tools and translate
/// arguments to form the list of jobs to run. /// arguments to form the list of jobs to run.
/// ///
/// \arg C - The compilation that is being built. /// \param C - The compilation that is being built.
void BuildJobs(Compilation &C) const; void BuildJobs(Compilation &C) const;
/// ExecuteCompilation - Execute the compilation according to the command line /// ExecuteCompilation - Execute the compilation according to the command line
@ -323,21 +323,20 @@ public:
/// PrintVersion - Print the driver version. /// PrintVersion - Print the driver version.
void PrintVersion(const Compilation &C, raw_ostream &OS) const; void PrintVersion(const Compilation &C, raw_ostream &OS) const;
/// GetFilePath - Lookup \arg Name in the list of file search paths. /// GetFilePath - Lookup \p Name in the list of file search paths.
/// ///
/// \arg TC - The tool chain for additional information on /// \param TC - The tool chain for additional information on
/// directories to search. /// directories to search.
// //
// FIXME: This should be in CompilationInfo. // FIXME: This should be in CompilationInfo.
std::string GetFilePath(const char *Name, const ToolChain &TC) const; std::string GetFilePath(const char *Name, const ToolChain &TC) const;
/// GetProgramPath - Lookup \arg Name in the list of program search /// GetProgramPath - Lookup \p Name in the list of program search paths.
/// paths.
/// ///
/// \arg TC - The provided tool chain for additional information on /// \param TC - The provided tool chain for additional information on
/// directories to search. /// directories to search.
/// ///
/// \arg WantFile - False when searching for an executable file, otherwise /// \param WantFile - False when searching for an executable file, otherwise
/// true. Defaults to false. /// true. Defaults to false.
// //
// FIXME: This should be in CompilationInfo. // FIXME: This should be in CompilationInfo.
@ -352,14 +351,14 @@ public:
bool HandleImmediateArgs(const Compilation &C); bool HandleImmediateArgs(const Compilation &C);
/// ConstructAction - Construct the appropriate action to do for /// ConstructAction - Construct the appropriate action to do for
/// \arg Phase on the \arg Input, taking in to account arguments /// \p Phase on the \p Input, taking in to account arguments
/// like -fsyntax-only or --analyze. /// like -fsyntax-only or --analyze.
Action *ConstructPhaseAction(const ArgList &Args, phases::ID Phase, Action *ConstructPhaseAction(const ArgList &Args, phases::ID Phase,
Action *Input) const; Action *Input) const;
/// BuildJobsForAction - Construct the jobs to perform for the /// BuildJobsForAction - Construct the jobs to perform for the
/// action \arg A. /// action \p A.
void BuildJobsForAction(Compilation &C, void BuildJobsForAction(Compilation &C,
const Action *A, const Action *A,
const ToolChain *TC, const ToolChain *TC,
@ -369,7 +368,7 @@ public:
InputInfo &Result) const; InputInfo &Result) const;
/// GetNamedOutputPath - Return the name to use for the output of /// GetNamedOutputPath - Return the name to use for the output of
/// the action \arg JA. The result is appended to the compilation's /// the action \p JA. The result is appended to the compilation's
/// list of temporary or result files, as appropriate. /// list of temporary or result files, as appropriate.
/// ///
/// \param C - The compilation. /// \param C - The compilation.

View File

@ -55,8 +55,8 @@ public:
/// driver add an additional "command failed" diagnostic on failures. /// driver add an additional "command failed" diagnostic on failures.
virtual bool hasGoodDiagnostics() const { return false; } virtual bool hasGoodDiagnostics() const { return false; }
/// ConstructJob - Construct jobs to perform the action \arg JA, /// ConstructJob - Construct jobs to perform the action \p JA,
/// writing to \arg Output and with \arg Inputs. /// writing to \p Output and with \p Inputs.
/// ///
/// \param TCArgs - The argument list for this toolchain, with any /// \param TCArgs - The argument list for this toolchain, with any
/// tool chain specific translations applied. /// tool chain specific translations applied.

View File

@ -107,8 +107,8 @@ public:
return 0; return 0;
} }
/// SelectTool - Choose a tool to use to handle the action \arg JA with the /// SelectTool - Choose a tool to use to handle the action \p JA with the
/// given \arg Inputs. /// given \p Inputs.
virtual Tool &SelectTool(const Compilation &C, const JobAction &JA, virtual Tool &SelectTool(const Compilation &C, const JobAction &JA,
const ActionList &Inputs) const = 0; const ActionList &Inputs) const = 0;

View File

@ -515,7 +515,7 @@ public:
void addFileLevelDecl(Decl *D); void addFileLevelDecl(Decl *D);
/// \brief Get the decls that are contained in a file in the Offset/Length /// \brief Get the decls that are contained in a file in the Offset/Length
/// range. \arg Length can be 0 to indicate a point at \arg Offset instead of /// range. \p Length can be 0 to indicate a point at \p Offset instead of
/// a range. /// a range.
void findFileRegionDecls(FileID File, unsigned Offset, unsigned Length, void findFileRegionDecls(FileID File, unsigned Offset, unsigned Length,
SmallVectorImpl<Decl *> &Decls); SmallVectorImpl<Decl *> &Decls);
@ -542,14 +542,14 @@ public:
/// \brief Get the source location for the given file:offset pair. /// \brief Get the source location for the given file:offset pair.
SourceLocation getLocation(const FileEntry *File, unsigned Offset) const; SourceLocation getLocation(const FileEntry *File, unsigned Offset) const;
/// \brief If \arg Loc is a loaded location from the preamble, returns /// \brief If \p Loc is a loaded location from the preamble, returns
/// the corresponding local location of the main file, otherwise it returns /// the corresponding local location of the main file, otherwise it returns
/// \arg Loc. /// \p Loc.
SourceLocation mapLocationFromPreamble(SourceLocation Loc); SourceLocation mapLocationFromPreamble(SourceLocation Loc);
/// \brief If \arg Loc is a local location of the main file but inside the /// \brief If \p Loc is a local location of the main file but inside the
/// preamble chunk, returns the corresponding loaded location from the /// preamble chunk, returns the corresponding loaded location from the
/// preamble, otherwise it returns \arg Loc. /// preamble, otherwise it returns \p Loc.
SourceLocation mapLocationToPreamble(SourceLocation Loc); SourceLocation mapLocationToPreamble(SourceLocation Loc);
bool isInPreambleFileID(SourceLocation Loc); bool isInPreambleFileID(SourceLocation Loc);

View File

@ -390,7 +390,7 @@ public:
ASTConsumer *takeASTConsumer() { return Consumer.take(); } ASTConsumer *takeASTConsumer() { return Consumer.take(); }
/// setASTConsumer - Replace the current AST consumer; the compiler instance /// setASTConsumer - Replace the current AST consumer; the compiler instance
/// takes ownership of \arg Value. /// takes ownership of \p Value.
void setASTConsumer(ASTConsumer *Value); void setASTConsumer(ASTConsumer *Value);
/// } /// }
@ -430,7 +430,7 @@ public:
} }
/// setCodeCompletionConsumer - Replace the current code completion consumer; /// setCodeCompletionConsumer - Replace the current code completion consumer;
/// the compiler instance takes ownership of \arg Value. /// the compiler instance takes ownership of \p Value.
void setCodeCompletionConsumer(CodeCompleteConsumer *Value); void setCodeCompletionConsumer(CodeCompleteConsumer *Value);
/// } /// }
@ -485,7 +485,7 @@ public:
/// Create a DiagnosticsEngine object with a the TextDiagnosticPrinter. /// Create a DiagnosticsEngine object with a the TextDiagnosticPrinter.
/// ///
/// The \arg Argc and \arg Argv arguments are used only for logging purposes, /// The \p Argc and \p Argv arguments are used only for logging purposes,
/// when the diagnostic options indicate that the compiler should output /// when the diagnostic options indicate that the compiler should output
/// logging information. /// logging information.
/// ///
@ -552,8 +552,7 @@ public:
void createCodeCompletionConsumer(); void createCodeCompletionConsumer();
/// Create a code completion consumer to print code completion results, at /// Create a code completion consumer to print code completion results, at
/// \arg Filename, \arg Line, and \arg Column, to the given output stream \arg /// \p Filename, \p Line, and \p Column, to the given output stream \p OS.
/// OS.
static CodeCompleteConsumer * static CodeCompleteConsumer *
createCodeCompletionConsumer(Preprocessor &PP, const std::string &Filename, createCodeCompletionConsumer(Preprocessor &PP, const std::string &Filename,
unsigned Line, unsigned Column, unsigned Line, unsigned Column,
@ -593,15 +592,15 @@ public:
/// Create a new output file, optionally deriving the output path name. /// Create a new output file, optionally deriving the output path name.
/// ///
/// If \arg OutputPath is empty, then createOutputFile will derive an output /// If \p OutputPath is empty, then createOutputFile will derive an output
/// path location as \arg BaseInput, with any suffix removed, and \arg /// path location as \p BaseInput, with any suffix removed, and \p Extension
/// Extension appended. If OutputPath is not stdout and \arg UseTemporary /// appended. If \p OutputPath is not stdout and \p UseTemporary
/// is true, createOutputFile will create a new temporary file that must be /// is true, createOutputFile will create a new temporary file that must be
/// renamed to OutputPath in the end. /// renamed to \p OutputPath in the end.
/// ///
/// \param OutputPath - If given, the path to the output file. /// \param OutputPath - If given, the path to the output file.
/// \param Error [out] - On failure, the error message. /// \param Error [out] - On failure, the error message.
/// \param BaseInput - If \arg OutputPath is empty, the input path name to use /// \param BaseInput - If \p OutputPath is empty, the input path name to use
/// for deriving the output path. /// for deriving the output path.
/// \param Extension - The extension to use for derived output names. /// \param Extension - The extension to use for derived output names.
/// \param Binary - The mode to open the file in. /// \param Binary - The mode to open the file in.
@ -610,7 +609,7 @@ public:
/// multithreaded use, as the underlying signal mechanism is not reentrant /// multithreaded use, as the underlying signal mechanism is not reentrant
/// \param UseTemporary - Create a new temporary file that must be renamed to /// \param UseTemporary - Create a new temporary file that must be renamed to
/// OutputPath in the end. /// OutputPath in the end.
/// \param CreateMissingDirectories - When \arg UseTemporary is true, create /// \param CreateMissingDirectories - When \p UseTemporary is true, create
/// missing directories in the output path. /// missing directories in the output path.
/// \param ResultPathName [out] - If given, the result path name will be /// \param ResultPathName [out] - If given, the result path name will be
/// stored here on success. /// stored here on success.

View File

@ -167,8 +167,8 @@ public:
/// @name Public Action Interface /// @name Public Action Interface
/// @{ /// @{
/// BeginSourceFile - Prepare the action for processing the input file \arg /// BeginSourceFile - Prepare the action for processing the input file
/// Filename; this is run after the options and frontend have been /// \p Input; this is run after the options and frontend have been
/// initialized, but prior to executing any per-file processing. /// initialized, but prior to executing any per-file processing.
/// ///
/// \param CI - The compiler instance this action is being run from. The /// \param CI - The compiler instance this action is being run from. The

View File

@ -125,7 +125,7 @@ public:
UseStandardSystemIncludes(true), UseStandardCXXIncludes(true), UseStandardSystemIncludes(true), UseStandardCXXIncludes(true),
UseLibcxx(false), Verbose(false) {} UseLibcxx(false), Verbose(false) {}
/// AddPath - Add the \arg Path path to the specified \arg Group list. /// AddPath - Add the \p Path path to the specified \p Group list.
void AddPath(StringRef Path, frontend::IncludeDirGroup Group, void AddPath(StringRef Path, frontend::IncludeDirGroup Group,
bool IsUserSupplied, bool IsFramework, bool IgnoreSysRoot, bool IsUserSupplied, bool IsFramework, bool IgnoreSysRoot,
bool IsInternal = false, bool ImplicitExternC = false) { bool IsInternal = false, bool ImplicitExternC = false) {
@ -134,7 +134,7 @@ public:
} }
/// AddSystemHeaderPrefix - Override whether \#include directives naming a /// AddSystemHeaderPrefix - Override whether \#include directives naming a
/// path starting with \arg Prefix should be considered as naming a system /// path starting with \p Prefix should be considered as naming a system
/// header. /// header.
void AddSystemHeaderPrefix(StringRef Prefix, bool IsSystemHeader) { void AddSystemHeaderPrefix(StringRef Prefix, bool IsSystemHeader) {
SystemHeaderPrefixes.push_back(SystemHeaderPrefix(Prefix, IsSystemHeader)); SystemHeaderPrefixes.push_back(SystemHeaderPrefix(Prefix, IsSystemHeader));

View File

@ -269,12 +269,12 @@ namespace clang {
virtual PreprocessedEntity *ReadPreprocessedEntity(unsigned Index) = 0; virtual PreprocessedEntity *ReadPreprocessedEntity(unsigned Index) = 0;
/// \brief Returns a pair of [Begin, End) indices of preallocated /// \brief Returns a pair of [Begin, End) indices of preallocated
/// preprocessed entities that \arg Range encompasses. /// preprocessed entities that \p Range encompasses.
virtual std::pair<unsigned, unsigned> virtual std::pair<unsigned, unsigned>
findPreprocessedEntitiesInRange(SourceRange Range) = 0; findPreprocessedEntitiesInRange(SourceRange Range) = 0;
/// \brief Optionally returns true or false if the preallocated preprocessed /// \brief Optionally returns true or false if the preallocated preprocessed
/// entity with index \arg Index came from file \arg FID. /// entity with index \p Index came from file \p FID.
virtual llvm::Optional<bool> isPreprocessedEntityInFileID(unsigned Index, virtual llvm::Optional<bool> isPreprocessedEntityInFileID(unsigned Index,
FileID FID) { FileID FID) {
return llvm::Optional<bool>(); return llvm::Optional<bool>();
@ -372,7 +372,7 @@ namespace clang {
} }
/// \brief Returns a pair of [Begin, End) indices of local preprocessed /// \brief Returns a pair of [Begin, End) indices of local preprocessed
/// entities that \arg Range encompasses. /// entities that \p Range encompasses.
std::pair<unsigned, unsigned> std::pair<unsigned, unsigned>
findLocalPreprocessedEntitiesInRange(SourceRange Range) const; findLocalPreprocessedEntitiesInRange(SourceRange Range) const;
unsigned findBeginLocalPreprocessedEntity(SourceLocation Loc) const; unsigned findBeginLocalPreprocessedEntity(SourceLocation Loc) const;
@ -540,14 +540,14 @@ namespace clang {
} }
/// \brief Returns a pair of [Begin, End) iterators of preprocessed entities /// \brief Returns a pair of [Begin, End) iterators of preprocessed entities
/// that source range \arg R encompasses. /// that source range \p R encompasses.
/// ///
/// \param R the range to look for preprocessed entities. /// \param R the range to look for preprocessed entities.
/// ///
std::pair<iterator, iterator> getPreprocessedEntitiesInRange(SourceRange R); std::pair<iterator, iterator> getPreprocessedEntitiesInRange(SourceRange R);
/// \brief Returns true if the preprocessed entity that \arg PPEI iterator /// \brief Returns true if the preprocessed entity that \p PPEI iterator
/// points to is coming from the file \arg FID. /// points to is coming from the file \p FID.
/// ///
/// Can be used to avoid implicit deserializations of preallocated /// Can be used to avoid implicit deserializations of preallocated
/// preprocessed entities if we only care about entities of a specific file /// preprocessed entities if we only care about entities of a specific file

View File

@ -506,8 +506,8 @@ public:
} }
/// RemovePragmaHandler - Remove the specific pragma handler from /// RemovePragmaHandler - Remove the specific pragma handler from
/// the preprocessor. If \arg Namespace is non-null, then it should /// the preprocessor. If \p Namespace is non-null, then it should
/// be the namespace that \arg Handler was added to. It is an error /// be the namespace that \p Handler was added to. It is an error
/// to remove a handler that has not been registered. /// to remove a handler that has not been registered.
void RemovePragmaHandler(StringRef Namespace, PragmaHandler *Handler); void RemovePragmaHandler(StringRef Namespace, PragmaHandler *Handler);
void RemovePragmaHandler(PragmaHandler *Handler) { void RemovePragmaHandler(PragmaHandler *Handler) {

View File

@ -169,7 +169,7 @@ private:
/// first token on the next line. /// first token on the next line.
void HandleMicrosoftCommentPaste(Token &Tok); void HandleMicrosoftCommentPaste(Token &Tok);
/// \brief If \arg loc is a FileID and points inside the current macro /// \brief If \p loc is a FileID and points inside the current macro
/// definition, returns the appropriate source location pointing at the /// definition, returns the appropriate source location pointing at the
/// macro expansion source location entry. /// macro expansion source location entry.
SourceLocation getExpansionLocForMacroDefLoc(SourceLocation loc) const; SourceLocation getExpansionLocForMacroDefLoc(SourceLocation loc) const;

View File

@ -183,7 +183,7 @@ public:
/// location was not rewritable, false otherwise. /// location was not rewritable, false otherwise.
/// ///
/// \param indentNewLines if true new lines in the string are indented /// \param indentNewLines if true new lines in the string are indented
/// using the indentation of the source line in position \arg Loc. /// using the indentation of the source line in position \p Loc.
bool InsertText(SourceLocation Loc, StringRef Str, bool InsertText(SourceLocation Loc, StringRef Str,
bool InsertAfter = true, bool indentNewLines = false); bool InsertAfter = true, bool indentNewLines = false);

View File

@ -901,9 +901,9 @@ public:
/// \brief Add a constructor-initialization step. /// \brief Add a constructor-initialization step.
/// ///
/// \arg FromInitList The constructor call is syntactically an initializer /// \param FromInitList The constructor call is syntactically an initializer
/// list. /// list.
/// \arg AsInitList The constructor is called as an init list constructor. /// \param AsInitList The constructor is called as an init list constructor.
void AddConstructorInitializationStep(CXXConstructorDecl *Constructor, void AddConstructorInitializationStep(CXXConstructorDecl *Constructor,
AccessSpecifier Access, AccessSpecifier Access,
QualType T, QualType T,

View File

@ -1650,7 +1650,7 @@ public:
/// \brief Checks availability of the function depending on the current /// \brief Checks availability of the function depending on the current
/// function context.Inside an unavailable function,unavailability is ignored. /// function context.Inside an unavailable function,unavailability is ignored.
/// ///
/// \returns true if \arg FD is unavailable and current context is inside /// \returns true if \p FD is unavailable and current context is inside
/// an available function, false otherwise. /// an available function, false otherwise.
bool isFunctionConsideredUnavailable(FunctionDecl *FD); bool isFunctionConsideredUnavailable(FunctionDecl *FD);
@ -6050,7 +6050,7 @@ public:
/// Ensure attributes are consistent with type. /// Ensure attributes are consistent with type.
/// \param [in, out] Attributes The attributes to check; they will /// \param [in, out] Attributes The attributes to check; they will
/// be modified to be consistent with \arg PropertyTy. /// be modified to be consistent with \p PropertyTy.
void CheckObjCPropertyAttributes(Decl *PropertyPtrTy, void CheckObjCPropertyAttributes(Decl *PropertyPtrTy,
SourceLocation Loc, SourceLocation Loc,
unsigned &Attributes, unsigned &Attributes,

View File

@ -836,14 +836,15 @@ private:
/// \brief Find the next module that contains entities and return the ID /// \brief Find the next module that contains entities and return the ID
/// of the first entry. /// of the first entry.
/// \arg SLocMapI points at a chunk of a module that contains no ///
/// \param SLocMapI points at a chunk of a module that contains no
/// preprocessed entities or the entities it contains are not the /// preprocessed entities or the entities it contains are not the
/// ones we are looking for. /// ones we are looking for.
serialization::PreprocessedEntityID serialization::PreprocessedEntityID
findNextPreprocessedEntity( findNextPreprocessedEntity(
GlobalSLocOffsetMapType::const_iterator SLocMapI) const; GlobalSLocOffsetMapType::const_iterator SLocMapI) const;
/// \brief Returns (ModuleFile, Local index) pair for \arg GlobalIndex of a /// \brief Returns (ModuleFile, Local index) pair for \p GlobalIndex of a
/// preprocessed entity. /// preprocessed entity.
std::pair<ModuleFile *, unsigned> std::pair<ModuleFile *, unsigned>
getModulePreprocessedEntity(unsigned GlobalIndex); getModulePreprocessedEntity(unsigned GlobalIndex);
@ -968,12 +969,12 @@ public:
virtual PreprocessedEntity *ReadPreprocessedEntity(unsigned Index); virtual PreprocessedEntity *ReadPreprocessedEntity(unsigned Index);
/// \brief Returns a pair of [Begin, End) indices of preallocated /// \brief Returns a pair of [Begin, End) indices of preallocated
/// preprocessed entities that \arg Range encompasses. /// preprocessed entities that \p Range encompasses.
virtual std::pair<unsigned, unsigned> virtual std::pair<unsigned, unsigned>
findPreprocessedEntitiesInRange(SourceRange Range); findPreprocessedEntitiesInRange(SourceRange Range);
/// \brief Optionally returns true or false if the preallocated preprocessed /// \brief Optionally returns true or false if the preallocated preprocessed
/// entity with index \arg Index came from file \arg FID. /// entity with index \p Index came from file \p FID.
virtual llvm::Optional<bool> isPreprocessedEntityInFileID(unsigned Index, virtual llvm::Optional<bool> isPreprocessedEntityInFileID(unsigned Index,
FileID FID); FileID FID);
@ -1067,15 +1068,14 @@ public:
/// global declaration ID. /// global declaration ID.
serialization::DeclID getGlobalDeclID(ModuleFile &F, unsigned LocalID) const; serialization::DeclID getGlobalDeclID(ModuleFile &F, unsigned LocalID) const;
/// \brief Returns true if global DeclID \arg ID originated from module /// \brief Returns true if global DeclID \p ID originated from module \p M.
/// \arg M.
bool isDeclIDFromModule(serialization::GlobalDeclID ID, ModuleFile &M) const; bool isDeclIDFromModule(serialization::GlobalDeclID ID, ModuleFile &M) const;
/// \brief Retrieve the module file that owns the given declaration, or NULL /// \brief Retrieve the module file that owns the given declaration, or NULL
/// if the declaration is not from a module file. /// if the declaration is not from a module file.
ModuleFile *getOwningModuleFile(Decl *D); ModuleFile *getOwningModuleFile(Decl *D);
/// \brief Returns the source location for the decl \arg ID. /// \brief Returns the source location for the decl \p ID.
SourceLocation getSourceLocationForDeclID(serialization::GlobalDeclID ID); SourceLocation getSourceLocationForDeclID(serialization::GlobalDeclID ID);
/// \brief Resolve a declaration ID into a declaration, potentially /// \brief Resolve a declaration ID into a declaration, potentially
@ -1172,7 +1172,7 @@ public:
SmallVectorImpl<Decl*> &Decls); SmallVectorImpl<Decl*> &Decls);
/// \brief Get the decls that are contained in a file in the Offset/Length /// \brief Get the decls that are contained in a file in the Offset/Length
/// range. \arg Length can be 0 to indicate a point at \arg Offset instead of /// range. \p Length can be 0 to indicate a point at \p Offset instead of
/// a range. /// a range.
virtual void FindFileRegionDecls(FileID File, unsigned Offset,unsigned Length, virtual void FindFileRegionDecls(FileID File, unsigned Offset,unsigned Length,
SmallVectorImpl<Decl *> &Decls); SmallVectorImpl<Decl *> &Decls);