On Sep 13, 2012, at 6:11 AM, Dmitri Gribenko <[email protected]> wrote:
> Author: gribozavr > Date: Thu Sep 13 08:11:20 2012 > New Revision: 163793 > > URL: http://llvm.org/viewvc/llvm-project?rev=163793&view=rev > Log: > Fix Doxygen misuse: refer to parameter names in paragraphs correctly (\arg is > not what most people want -- it starts a new paragraph). Is there a warning that goes along with this? - Doug > Modified: > cfe/trunk/include/clang-c/Index.h > cfe/trunk/include/clang/ARCMigrate/ARCMT.h > cfe/trunk/include/clang/AST/ASTContext.h > cfe/trunk/include/clang/AST/CharUnits.h > cfe/trunk/include/clang/AST/Decl.h > cfe/trunk/include/clang/AST/DeclObjC.h > cfe/trunk/include/clang/AST/ExternalASTSource.h > cfe/trunk/include/clang/AST/NSAPI.h > cfe/trunk/include/clang/AST/SelectorLocationsKind.h > cfe/trunk/include/clang/CodeGen/CodeGenAction.h > cfe/trunk/include/clang/Driver/ArgList.h > cfe/trunk/include/clang/Driver/Compilation.h > cfe/trunk/include/clang/Driver/Driver.h > cfe/trunk/include/clang/Driver/Tool.h > cfe/trunk/include/clang/Driver/ToolChain.h > cfe/trunk/include/clang/Frontend/ASTUnit.h > cfe/trunk/include/clang/Frontend/CompilerInstance.h > cfe/trunk/include/clang/Frontend/FrontendAction.h > cfe/trunk/include/clang/Frontend/HeaderSearchOptions.h > cfe/trunk/include/clang/Lex/PreprocessingRecord.h > cfe/trunk/include/clang/Lex/Preprocessor.h > cfe/trunk/include/clang/Lex/TokenLexer.h > cfe/trunk/include/clang/Rewrite/Core/Rewriter.h > cfe/trunk/include/clang/Sema/Initialization.h > cfe/trunk/include/clang/Sema/Sema.h > cfe/trunk/include/clang/Serialization/ASTReader.h > > Modified: cfe/trunk/include/clang-c/Index.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang-c/Index.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang-c/Index.h (original) > +++ cfe/trunk/include/clang-c/Index.h Thu Sep 13 08:11:20 2012 > @@ -383,7 +383,7 @@ > 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); > > @@ -2069,9 +2069,9 @@ > 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. > > Modified: cfe/trunk/include/clang/ARCMigrate/ARCMT.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/ARCMigrate/ARCMT.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/ARCMigrate/ARCMT.h (original) > +++ cfe/trunk/include/clang/ARCMigrate/ARCMT.h Thu Sep 13 08:11:20 2012 > @@ -51,7 +51,7 @@ > DiagnosticConsumer *DiagClient); > > /// \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 > /// even if the migrator can fix them, but the function will still return > false > @@ -68,7 +68,7 @@ > bool emitPremigrationARCErrors, > 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. > /// > /// \returns false if no error is produced, true otherwise. > > Modified: cfe/trunk/include/clang/AST/ASTContext.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/AST/ASTContext.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/AST/ASTContext.h (original) > +++ cfe/trunk/include/clang/AST/ASTContext.h Thu Sep 13 08:11:20 2012 > @@ -1325,8 +1325,8 @@ > /// for some targets. > QualType getVaListTagType() const; > > - /// \brief Return a type with additional \c const, \c volatile, or > \crestrict > - /// qualifiers. > + /// \brief Return a type with additional \c const, \c volatile, or > + /// \c restrict qualifiers. > QualType getCVRQualifiedType(QualType T, unsigned CVR) const { > return getQualifiedType(T, Qualifiers::fromCVRMask(CVR)); > } > @@ -1756,8 +1756,8 @@ > /// \brief Return a real floating point or a complex type (based on > /// \p typeDomain/\p typeSize). > /// > - /// \arg typeDomain a real floating point or complex type. > - /// \arg typeSize a real floating point or complex type. > + /// \param typeDomain a real floating point or complex type. > + /// \param typeSize a real floating point or complex type. > QualType getFloatingTypeOfSizeWithinDomain(QualType typeSize, > QualType typeDomain) const; > > > Modified: cfe/trunk/include/clang/AST/CharUnits.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/AST/CharUnits.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/AST/CharUnits.h (original) > +++ cfe/trunk/include/clang/AST/CharUnits.h Thu Sep 13 08:11:20 2012 > @@ -164,8 +164,8 @@ > QuantityType getQuantity() const { return Quantity; } > > /// RoundUpToAlignment - Returns the next integer (mod 2**64) that is > - /// greater than or equal to this quantity and is a multiple of \arg > - /// Align. Align must be non-zero. > + /// greater than or equal to this quantity and is a multiple of \p > Align. > + /// Align must be non-zero. > CharUnits RoundUpToAlignment(const CharUnits &Align) { > return CharUnits(llvm::RoundUpToAlignment(Quantity, > Align.Quantity)); > > Modified: cfe/trunk/include/clang/AST/Decl.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/AST/Decl.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/AST/Decl.h (original) > +++ cfe/trunk/include/clang/AST/Decl.h Thu Sep 13 08:11:20 2012 > @@ -712,7 +712,7 @@ > typedef clang::StorageClass StorageClass; > > /// 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. > static const char *getStorageClassSpecifierString(StorageClass SC); > > Modified: cfe/trunk/include/clang/AST/DeclObjC.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/AST/DeclObjC.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/AST/DeclObjC.h (original) > +++ cfe/trunk/include/clang/AST/DeclObjC.h Thu Sep 13 08:11:20 2012 > @@ -363,7 +363,7 @@ > } > > /// \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. > void setMethodParams(ASTContext &C, > ArrayRef<ParmVarDecl*> Params, > > Modified: cfe/trunk/include/clang/AST/ExternalASTSource.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/AST/ExternalASTSource.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/AST/ExternalASTSource.h (original) > +++ cfe/trunk/include/clang/AST/ExternalASTSource.h Thu Sep 13 08:11:20 2012 > @@ -162,7 +162,7 @@ > } > > /// \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. > virtual void FindFileRegionDecls(FileID File, unsigned Offset,unsigned > Length, > SmallVectorImpl<Decl *> &Decls) {} > > Modified: cfe/trunk/include/clang/AST/NSAPI.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/AST/NSAPI.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/AST/NSAPI.h (original) > +++ cfe/trunk/include/clang/AST/NSAPI.h Thu Sep 13 08:11:20 2012 > @@ -83,7 +83,7 @@ > /// \brief The Objective-C NSArray selectors. > 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); > > /// \brief Enumerates the NSDictionary methods used to generate literals. > @@ -104,7 +104,7 @@ > /// \brief The Objective-C NSDictionary selectors. > 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> > getNSDictionaryMethodKind(Selector Sel); > > @@ -169,7 +169,7 @@ > 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> > getNSNumberLiteralMethodKind(Selector Sel) const; > > > Modified: cfe/trunk/include/clang/AST/SelectorLocationsKind.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/AST/SelectorLocationsKind.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/AST/SelectorLocationsKind.h (original) > +++ cfe/trunk/include/clang/AST/SelectorLocationsKind.h Thu Sep 13 08:11:20 > 2012 > @@ -42,7 +42,7 @@ > 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, > ArrayRef<SourceLocation> > SelLocs, > ArrayRef<Expr *> Args, > @@ -60,7 +60,7 @@ > ArrayRef<Expr *> Args, > 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, > ArrayRef<SourceLocation> > SelLocs, > ArrayRef<ParmVarDecl *> Args, > > Modified: cfe/trunk/include/clang/CodeGen/CodeGenAction.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/CodeGen/CodeGenAction.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/CodeGen/CodeGenAction.h (original) > +++ cfe/trunk/include/clang/CodeGen/CodeGenAction.h Thu Sep 13 08:11:20 2012 > @@ -30,7 +30,7 @@ > bool OwnsVMContext; > > 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, > /// otherwise it creates a fresh LLVM context and takes ownership. > CodeGenAction(unsigned _Act, llvm::LLVMContext *_VMContext = 0); > > Modified: cfe/trunk/include/clang/Driver/ArgList.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Driver/ArgList.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Driver/ArgList.h (original) > +++ cfe/trunk/include/clang/Driver/ArgList.h Thu Sep 13 08:11:20 2012 > @@ -117,7 +117,7 @@ > /// @name Arg Access > /// @{ > > - /// append - Append \arg A to the arg list. > + /// append - Append \p A to the arg list. > void append(Arg *A); > > arglist_type &getArgs() { return Args; } > @@ -153,16 +153,16 @@ > /// @name Arg Removal > /// @{ > > - /// eraseArg - Remove any option matching \arg Id. > + /// eraseArg - Remove any option matching \p Id. > void eraseArg(OptSpecifier Id); > > /// @} > /// @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 { > return getLastArgNoClaim(Id) != 0; > } > @@ -176,9 +176,9 @@ > 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 *getLastArg(OptSpecifier Id) const; > Arg *getLastArg(OptSpecifier Id0, OptSpecifier Id1) const; > @@ -196,7 +196,7 @@ > OptSpecifier Id3, OptSpecifier Id4, OptSpecifier Id5, > 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; > > /// getNumInputArgStrings - Return the number of original argument > strings, > @@ -233,15 +233,13 @@ > /// @name Translation Utilities > /// @{ > > - /// hasFlag - Given an option \arg Pos and its negative form \arg > - /// Neg, return true if the option is present, false if the > - /// negation is present, and \arg Default if neither option is > - /// given. If both the option and its negation are present, the > - /// last one wins. > + /// hasFlag - Given an option \p Pos and its negative form \p Neg, return > + /// true if the option is present, false if the negation is present, and > + /// \p Default if neither option is given. If both the option and its > + /// negation are present, the last one wins. > bool hasFlag(OptSpecifier Pos, OptSpecifier Neg, bool Default=true) const; > > - /// AddLastArg - Render only the last argument match \arg Id0, if > - /// present. > + /// AddLastArg - Render only the last argument match \p Id0, if present. > void AddLastArg(ArgStringList &Output, OptSpecifier Id0) const; > > /// AddAllArgs - Render all arguments matching the given ids. > @@ -286,8 +284,8 @@ > } > const char *MakeArgString(const Twine &Str) const; > > - /// \brief Create an arg string for (\arg LHS + \arg RHS), reusing the > - /// string at \arg Index if possible. > + /// \brief Create an arg string for (\p LHS + \p RHS), reusing the > + /// string at \p Index if possible. > const char *GetOrMakeJoinedArgString(unsigned Index, StringRef LHS, > StringRef RHS) const; > > @@ -347,7 +345,7 @@ > mutable arglist_type SynthesizedArgs; > > public: > - /// Construct a new derived arg list from \arg BaseArgs. > + /// Construct a new derived arg list from \p BaseArgs. > DerivedArgList(const InputArgList &BaseArgs); > ~DerivedArgList(); > > @@ -374,14 +372,14 @@ > > 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. > void AddFlagArg(const Arg *BaseArg, const Option *Opt) { > append(MakeFlagArg(BaseArg, Opt)); > } > > /// 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. > void AddPositionalArg(const Arg *BaseArg, const Option *Opt, > StringRef Value) { > @@ -390,7 +388,7 @@ > > > /// 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. > void AddSeparateArg(const Arg *BaseArg, const Option *Opt, > StringRef Value) { > @@ -398,30 +396,29 @@ > } > > > - /// AddJoinedArg - Construct a new Positional arg for the given option > \arg > - /// Id, with the provided \arg Value and append it to the argument list. > + /// AddJoinedArg - Construct a new Positional arg for the given option > + /// \p Id, with the provided \p Value and append it to the argument list. > void AddJoinedArg(const Arg *BaseArg, const Option *Opt, > StringRef Value) { > append(MakeJoinedArg(BaseArg, Opt, Value)); > } > > > - /// MakeFlagArg - Construct a new FlagArg for the given option > - /// \arg Id. > + /// MakeFlagArg - Construct a new FlagArg for the given option \p Id. > Arg *MakeFlagArg(const Arg *BaseArg, const Option *Opt) const; > > /// 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, > StringRef Value) const; > > /// 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, > StringRef Value) const; > > /// 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, > StringRef Value) const; > > > Modified: cfe/trunk/include/clang/Driver/Compilation.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Driver/Compilation.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Driver/Compilation.h (original) > +++ cfe/trunk/include/clang/Driver/Compilation.h Thu Sep 13 08:11:20 2012 > @@ -98,8 +98,7 @@ > StringRef getSysRoot() const; > > /// getArgsForToolChain - Return the derived argument list for the > - /// tool chain \arg TC (or the default tool chain, if TC is not > - /// specified). > + /// tool chain \p TC (or the default tool chain, if TC is not specified). > /// > /// \param BoundArch - The bound architecture name, or 0. > const DerivedArgList &getArgsForToolChain(const ToolChain *TC, > > Modified: cfe/trunk/include/clang/Driver/Driver.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Driver/Driver.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Driver/Driver.h (original) > +++ cfe/trunk/include/clang/Driver/Driver.h Thu Sep 13 08:11:20 2012 > @@ -287,7 +287,7 @@ > /// BuildJobs - Bind actions to concrete tools and translate > /// 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; > > /// ExecuteCompilation - Execute the compilation according to the command > line > @@ -323,21 +323,20 @@ > /// PrintVersion - Print the driver version. > 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. > // > // FIXME: This should be in CompilationInfo. > std::string GetFilePath(const char *Name, const ToolChain &TC) const; > > - /// GetProgramPath - Lookup \arg Name in the list of program search > - /// paths. > + /// GetProgramPath - Lookup \p Name in the list of program search paths. > /// > - /// \arg TC - The provided tool chain for additional information on > + /// \param TC - The provided tool chain for additional information on > /// 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. > // > // FIXME: This should be in CompilationInfo. > @@ -352,14 +351,14 @@ > bool HandleImmediateArgs(const Compilation &C); > > /// 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. > Action *ConstructPhaseAction(const ArgList &Args, phases::ID Phase, > Action *Input) const; > > > /// BuildJobsForAction - Construct the jobs to perform for the > - /// action \arg A. > + /// action \p A. > void BuildJobsForAction(Compilation &C, > const Action *A, > const ToolChain *TC, > @@ -369,7 +368,7 @@ > InputInfo &Result) const; > > /// 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. > /// > /// \param C - The compilation. > > Modified: cfe/trunk/include/clang/Driver/Tool.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Driver/Tool.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Driver/Tool.h (original) > +++ cfe/trunk/include/clang/Driver/Tool.h Thu Sep 13 08:11:20 2012 > @@ -55,8 +55,8 @@ > /// driver add an additional "command failed" diagnostic on failures. > virtual bool hasGoodDiagnostics() const { return false; } > > - /// ConstructJob - Construct jobs to perform the action \arg JA, > - /// writing to \arg Output and with \arg Inputs. > + /// ConstructJob - Construct jobs to perform the action \p JA, > + /// writing to \p Output and with \p Inputs. > /// > /// \param TCArgs - The argument list for this toolchain, with any > /// tool chain specific translations applied. > > Modified: cfe/trunk/include/clang/Driver/ToolChain.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Driver/ToolChain.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Driver/ToolChain.h (original) > +++ cfe/trunk/include/clang/Driver/ToolChain.h Thu Sep 13 08:11:20 2012 > @@ -107,8 +107,8 @@ > return 0; > } > > - /// SelectTool - Choose a tool to use to handle the action \arg JA with the > - /// given \arg Inputs. > + /// SelectTool - Choose a tool to use to handle the action \p JA with the > + /// given \p Inputs. > virtual Tool &SelectTool(const Compilation &C, const JobAction &JA, > const ActionList &Inputs) const = 0; > > > Modified: cfe/trunk/include/clang/Frontend/ASTUnit.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Frontend/ASTUnit.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Frontend/ASTUnit.h (original) > +++ cfe/trunk/include/clang/Frontend/ASTUnit.h Thu Sep 13 08:11:20 2012 > @@ -515,7 +515,7 @@ > void addFileLevelDecl(Decl *D); > > /// \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. > void findFileRegionDecls(FileID File, unsigned Offset, unsigned Length, > SmallVectorImpl<Decl *> &Decls); > @@ -542,14 +542,14 @@ > /// \brief Get the source location for the given file:offset pair. > 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 > - /// \arg Loc. > + /// \p 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, otherwise it returns \arg Loc. > + /// preamble, otherwise it returns \p Loc. > SourceLocation mapLocationToPreamble(SourceLocation Loc); > > bool isInPreambleFileID(SourceLocation Loc); > > Modified: cfe/trunk/include/clang/Frontend/CompilerInstance.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Frontend/CompilerInstance.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Frontend/CompilerInstance.h (original) > +++ cfe/trunk/include/clang/Frontend/CompilerInstance.h Thu Sep 13 08:11:20 > 2012 > @@ -390,7 +390,7 @@ > ASTConsumer *takeASTConsumer() { return Consumer.take(); } > > /// setASTConsumer - Replace the current AST consumer; the compiler instance > - /// takes ownership of \arg Value. > + /// takes ownership of \p Value. > void setASTConsumer(ASTConsumer *Value); > > /// } > @@ -430,7 +430,7 @@ > } > > /// 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); > > /// } > @@ -485,7 +485,7 @@ > > /// 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 > /// logging information. > /// > @@ -552,8 +552,7 @@ > void createCodeCompletionConsumer(); > > /// Create a code completion consumer to print code completion results, at > - /// \arg Filename, \arg Line, and \arg Column, to the given output stream > \arg > - /// OS. > + /// \p Filename, \p Line, and \p Column, to the given output stream \p OS. > static CodeCompleteConsumer * > createCodeCompletionConsumer(Preprocessor &PP, const std::string &Filename, > unsigned Line, unsigned Column, > @@ -593,15 +592,15 @@ > > /// Create a new output file, optionally deriving the output path name. > /// > - /// If \arg OutputPath is empty, then createOutputFile will derive an > output > - /// path location as \arg BaseInput, with any suffix removed, and \arg > - /// Extension appended. If OutputPath is not stdout and \arg UseTemporary > + /// If \p OutputPath is empty, then createOutputFile will derive an output > + /// path location as \p BaseInput, with any suffix removed, and \p > Extension > + /// appended. If \p OutputPath is not stdout and \p UseTemporary > /// 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 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. > /// \param Extension - The extension to use for derived output names. > /// \param Binary - The mode to open the file in. > @@ -610,7 +609,7 @@ > /// multithreaded use, as the underlying signal mechanism is not reentrant > /// \param UseTemporary - Create a new temporary file that must be renamed > to > /// 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. > /// \param ResultPathName [out] - If given, the result path name will be > /// stored here on success. > > Modified: cfe/trunk/include/clang/Frontend/FrontendAction.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Frontend/FrontendAction.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Frontend/FrontendAction.h (original) > +++ cfe/trunk/include/clang/Frontend/FrontendAction.h Thu Sep 13 08:11:20 2012 > @@ -167,8 +167,8 @@ > /// @name Public Action Interface > /// @{ > > - /// BeginSourceFile - Prepare the action for processing the input file \arg > - /// Filename; this is run after the options and frontend have been > + /// BeginSourceFile - Prepare the action for processing the input file > + /// \p Input; this is run after the options and frontend have been > /// initialized, but prior to executing any per-file processing. > /// > /// \param CI - The compiler instance this action is being run from. The > > Modified: cfe/trunk/include/clang/Frontend/HeaderSearchOptions.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Frontend/HeaderSearchOptions.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Frontend/HeaderSearchOptions.h (original) > +++ cfe/trunk/include/clang/Frontend/HeaderSearchOptions.h Thu Sep 13 > 08:11:20 2012 > @@ -125,7 +125,7 @@ > UseStandardSystemIncludes(true), UseStandardCXXIncludes(true), > 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, > bool IsUserSupplied, bool IsFramework, bool IgnoreSysRoot, > bool IsInternal = false, bool ImplicitExternC = false) { > @@ -134,7 +134,7 @@ > } > > /// 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. > void AddSystemHeaderPrefix(StringRef Prefix, bool IsSystemHeader) { > SystemHeaderPrefixes.push_back(SystemHeaderPrefix(Prefix, > IsSystemHeader)); > > Modified: cfe/trunk/include/clang/Lex/PreprocessingRecord.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Lex/PreprocessingRecord.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Lex/PreprocessingRecord.h (original) > +++ cfe/trunk/include/clang/Lex/PreprocessingRecord.h Thu Sep 13 08:11:20 2012 > @@ -269,12 +269,12 @@ > virtual PreprocessedEntity *ReadPreprocessedEntity(unsigned Index) = 0; > > /// \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> > findPreprocessedEntitiesInRange(SourceRange Range) = 0; > > /// \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, > FileID FID) { > return llvm::Optional<bool>(); > @@ -372,7 +372,7 @@ > } > > /// \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> > findLocalPreprocessedEntitiesInRange(SourceRange Range) const; > unsigned findBeginLocalPreprocessedEntity(SourceLocation Loc) const; > @@ -540,14 +540,14 @@ > } > > /// \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. > /// > std::pair<iterator, iterator> getPreprocessedEntitiesInRange(SourceRange > R); > > - /// \brief Returns true if the preprocessed entity that \arg PPEI > iterator > - /// points to is coming from the file \arg FID. > + /// \brief Returns true if the preprocessed entity that \p PPEI iterator > + /// points to is coming from the file \p FID. > /// > /// Can be used to avoid implicit deserializations of preallocated > /// preprocessed entities if we only care about entities of a specific > file > > Modified: cfe/trunk/include/clang/Lex/Preprocessor.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Lex/Preprocessor.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Lex/Preprocessor.h (original) > +++ cfe/trunk/include/clang/Lex/Preprocessor.h Thu Sep 13 08:11:20 2012 > @@ -506,8 +506,8 @@ > } > > /// RemovePragmaHandler - Remove the specific pragma handler from > - /// the preprocessor. If \arg Namespace is non-null, then it should > - /// be the namespace that \arg Handler was added to. It is an error > + /// the preprocessor. If \p Namespace is non-null, then it should > + /// be the namespace that \p Handler was added to. It is an error > /// to remove a handler that has not been registered. > void RemovePragmaHandler(StringRef Namespace, PragmaHandler *Handler); > void RemovePragmaHandler(PragmaHandler *Handler) { > > Modified: cfe/trunk/include/clang/Lex/TokenLexer.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Lex/TokenLexer.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Lex/TokenLexer.h (original) > +++ cfe/trunk/include/clang/Lex/TokenLexer.h Thu Sep 13 08:11:20 2012 > @@ -169,7 +169,7 @@ > /// first token on the next line. > 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 > /// macro expansion source location entry. > SourceLocation getExpansionLocForMacroDefLoc(SourceLocation loc) const; > > Modified: cfe/trunk/include/clang/Rewrite/Core/Rewriter.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Rewrite/Core/Rewriter.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Rewrite/Core/Rewriter.h (original) > +++ cfe/trunk/include/clang/Rewrite/Core/Rewriter.h Thu Sep 13 08:11:20 2012 > @@ -183,7 +183,7 @@ > /// location was not rewritable, false otherwise. > /// > /// \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 InsertAfter = true, bool indentNewLines = false); > > > Modified: cfe/trunk/include/clang/Sema/Initialization.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Sema/Initialization.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Sema/Initialization.h (original) > +++ cfe/trunk/include/clang/Sema/Initialization.h Thu Sep 13 08:11:20 2012 > @@ -901,9 +901,9 @@ > > /// \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. > - /// \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, > AccessSpecifier Access, > QualType T, > > Modified: cfe/trunk/include/clang/Sema/Sema.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Sema/Sema.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Sema/Sema.h (original) > +++ cfe/trunk/include/clang/Sema/Sema.h Thu Sep 13 08:11:20 2012 > @@ -1650,7 +1650,7 @@ > /// \brief Checks availability of the function depending on the current > /// 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. > bool isFunctionConsideredUnavailable(FunctionDecl *FD); > > @@ -6050,7 +6050,7 @@ > > /// Ensure attributes are consistent with type. > /// \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, > SourceLocation Loc, > unsigned &Attributes, > > Modified: cfe/trunk/include/clang/Serialization/ASTReader.h > URL: > http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Serialization/ASTReader.h?rev=163793&r1=163792&r2=163793&view=diff > ============================================================================== > --- cfe/trunk/include/clang/Serialization/ASTReader.h (original) > +++ cfe/trunk/include/clang/Serialization/ASTReader.h Thu Sep 13 08:11:20 2012 > @@ -836,14 +836,15 @@ > > /// \brief Find the next module that contains entities and return the ID > /// 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 > /// ones we are looking for. > serialization::PreprocessedEntityID > findNextPreprocessedEntity( > 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. > std::pair<ModuleFile *, unsigned> > getModulePreprocessedEntity(unsigned GlobalIndex); > @@ -968,12 +969,12 @@ > virtual PreprocessedEntity *ReadPreprocessedEntity(unsigned Index); > > /// \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> > findPreprocessedEntitiesInRange(SourceRange Range); > > /// \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, > FileID FID); > > @@ -1067,15 +1068,14 @@ > /// global declaration ID. > serialization::DeclID getGlobalDeclID(ModuleFile &F, unsigned LocalID) > const; > > - /// \brief Returns true if global DeclID \arg ID originated from module > - /// \arg M. > + /// \brief Returns true if global DeclID \p ID originated from module \p M. > bool isDeclIDFromModule(serialization::GlobalDeclID ID, ModuleFile &M) > const; > > /// \brief Retrieve the module file that owns the given declaration, or NULL > /// if the declaration is not from a module file. > 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); > > /// \brief Resolve a declaration ID into a declaration, potentially > @@ -1172,7 +1172,7 @@ > SmallVectorImpl<Decl*> &Decls); > > /// \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. > virtual void FindFileRegionDecls(FileID File, unsigned Offset,unsigned > Length, > SmallVectorImpl<Decl *> &Decls); > > > _______________________________________________ > cfe-commits mailing list > [email protected] > http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits _______________________________________________ cfe-commits mailing list [email protected] http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
