]> granicus.if.org Git - clang/commitdiff
Fix Doxygen misuse: refer to parameter names in paragraphs correctly (\arg is
authorDmitri Gribenko <gribozavr@gmail.com>
Thu, 13 Sep 2012 13:11:20 +0000 (13:11 +0000)
committerDmitri Gribenko <gribozavr@gmail.com>
Thu, 13 Sep 2012 13:11:20 +0000 (13:11 +0000)
not what most people want -- it starts a new paragraph).

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@163793 91177308-0d34-0410-b5e6-96231b3b80d8

26 files changed:
include/clang-c/Index.h
include/clang/ARCMigrate/ARCMT.h
include/clang/AST/ASTContext.h
include/clang/AST/CharUnits.h
include/clang/AST/Decl.h
include/clang/AST/DeclObjC.h
include/clang/AST/ExternalASTSource.h
include/clang/AST/NSAPI.h
include/clang/AST/SelectorLocationsKind.h
include/clang/CodeGen/CodeGenAction.h
include/clang/Driver/ArgList.h
include/clang/Driver/Compilation.h
include/clang/Driver/Driver.h
include/clang/Driver/Tool.h
include/clang/Driver/ToolChain.h
include/clang/Frontend/ASTUnit.h
include/clang/Frontend/CompilerInstance.h
include/clang/Frontend/FrontendAction.h
include/clang/Frontend/HeaderSearchOptions.h
include/clang/Lex/PreprocessingRecord.h
include/clang/Lex/Preprocessor.h
include/clang/Lex/TokenLexer.h
include/clang/Rewrite/Core/Rewriter.h
include/clang/Sema/Initialization.h
include/clang/Sema/Sema.h
include/clang/Serialization/ASTReader.h

index 912e657480dabbcfd94cc4edbe37c7b63e63f9a1..1280fb3de42298a8da636c677be29dff88841b91 100644 (file)
@@ -383,7 +383,7 @@ CINDEX_LINKAGE unsigned clang_equalRanges(CXSourceRange range1,
                                           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 CXCursor clang_getTranslationUnitCursor(CXTranslationUnit);
 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.
index 86a6cbb22aae38e0248e6db97211e8cb7903a811..0bb91aa7b15f9b1d51654c0622ff9d446abc1a7a 100644 (file)
@@ -51,7 +51,7 @@ bool applyTransformations(CompilerInvocation &origCI,
                           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 migrateWithTemporaryFiles(CompilerInvocation &origCI,
                                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.
index 5555e97a8c9a2b6a85a4b7b2c1825c0b0f5f17a3..3c283bc8f5c8a3b4c136b9e3b9d139bbee16120e 100644 (file)
@@ -1325,8 +1325,8 @@ public:
   /// 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 @@ public:
   /// \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;
 
index 5be35826a964e1e9f01ab97aa903596dd41c64a1..12e74b32be8a85072e409f6820d917283bacbe29 100644 (file)
@@ -164,8 +164,8 @@ namespace clang {
       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));
index 5dcc104874892b9c9ac669f7ee7368aa70a3135e..4d0cde8a432e7b97c986aed03f954cb299821b71 100644 (file)
@@ -712,7 +712,7 @@ public:
   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);
index 6c39f2c3abe1bdf7b81df7745a8b3a8e96800288..855fe69461b7b7513fc1f0881fa57f63e39b050a 100644 (file)
@@ -363,7 +363,7 @@ public:
   }
 
   /// \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,
index 7aedfe2ef6004c5454ae03cf2496d1cbb654a7bd..db2bddb4bfca91504315261e670f07a969ac55dd 100644 (file)
@@ -162,7 +162,7 @@ public:
   }
 
   /// \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) {}
index 51ae1daf14f38d879f128443acbd068f57cf0f6c..f9fd1f906b5553c6b08d95be82b628e630685abf 100644 (file)
@@ -83,7 +83,7 @@ public:
   /// \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 @@ public:
   /// \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 @@ public:
            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;
 
index cd43a5c49c55730d9f625decc4d6f5bf958ae77b..6d903f820cd497da7fcfad0cec37792cc8043705 100644 (file)
@@ -42,7 +42,7 @@ enum SelectorLocationsKind {
   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 @@ SourceLocation getStandardSelectorLoc(unsigned Index,
                                       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,
index 7fa589feebf8530539dba7c8b39184f7895937a4..912ef01a018c320557d53584dfd1acfa0588599d 100644 (file)
@@ -30,7 +30,7 @@ private:
   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);
index b7e490ccf7ca5065cc9f5fb699b872cdb50791af..ce0c79eb977e180b7576ffe198c53d7187ccb174 100644 (file)
@@ -117,7 +117,7 @@ namespace driver {
     /// @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 @@ namespace driver {
     /// @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 @@ namespace driver {
       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 @@ namespace driver {
                     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 @@ namespace driver {
     /// @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 @@ namespace driver {
     }
     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 @@ namespace driver {
     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 @@ namespace driver {
 
     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 @@ namespace driver {
 
 
     /// 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 @@ namespace driver {
     }
 
 
-    /// 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;
 
index 7a10d567354b1d3fefa11ebfae25a3af2c02d5d3..daa4dea410df0a2ff3057f86f970af6c20105b1b 100644 (file)
@@ -98,8 +98,7 @@ public:
   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,
index 609505597a70ae2d88aa6177e135615c4dfb50b1..0051365e17ec7733c4c17aab1bd26385874b56fd 100644 (file)
@@ -287,7 +287,7 @@ public:
   /// 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 @@ public:
   /// 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 @@ public:
   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 @@ public:
                           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.
index 8822d7b3fe24007fcbceb7a491b4456c9f90d5cf..c62e7567ea3ee154365d24b21faa31b6dfd474e0 100644 (file)
@@ -55,8 +55,8 @@ public:
   /// 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.
index bc6331e897bf7d5a7eff5883c1b8027ff0042513..082d8762d47da0b6aa17fc9d2a3ef7a847a6f28c 100644 (file)
@@ -107,8 +107,8 @@ public:
     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;
 
index 7aeb437554c7cd851d1090a8d3f55ee7768e5bf2..df16762beaef4a3fa0b47bcce9fd5c0b9f3af226 100644 (file)
@@ -515,7 +515,7 @@ public:
   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 @@ public:
   /// \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);
index 8f1d590686be9a7c4a79b3721f8a9d1cedb62bc1..c819b41314e99df31a58ea90b2343dc3a84886fb 100644 (file)
@@ -390,7 +390,7 @@ public:
   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 @@ public:
   }
 
   /// 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 @@ public:
 
   /// 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 @@ public:
   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 @@ public:
 
   /// 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 @@ public:
   /// 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.
index c0056de5cae34f928de53dab303613608e9aebc5..df26671fb7716d018fd33766640e663ba30efcfe 100644 (file)
@@ -167,8 +167,8 @@ public:
   /// @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
index ebc8f264b2a225f8ede339af4e90b9dfe74c9c64..e12884d1001c6c0a04fe6760bcfd59e503a4b139 100644 (file)
@@ -125,7 +125,7 @@ public:
       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 @@ public:
   }
 
   /// 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));
index fb3e081961bf820fd8a13ed3db5d10ae0b210fe8..4fd43453d6bb0f9a4aa18eb2f5afd0b234991353 100644 (file)
@@ -269,12 +269,12 @@ namespace clang {
     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 @@ namespace clang {
     }
 
     /// \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 @@ namespace clang {
     }
 
     /// \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
index 053200de5b8023bc835215cc4d8e88690ed59e1c..edd9a9e56c85060a2398b4054deadc2104f8c601 100644 (file)
@@ -506,8 +506,8 @@ public:
   }
 
   /// 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) {
index 6f11e126e97addbdbf9ccc65d3777429493d4778..e205bec5531eac569b23ba548bd02a400c3387c7 100644 (file)
@@ -169,7 +169,7 @@ private:
   /// 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;
index 9498e174f34c3eaa9899bb8916b1287d9b87af01..a33ea134a7ac1bb8b928872f85e14a4c251e782a 100644 (file)
@@ -183,7 +183,7 @@ public:
   /// 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);
 
index 77659be1470f1408fde033212675f9e55f5f3901..0b0af0cff6ef70b4e5f3193e291c748d1d8f6ce3 100644 (file)
@@ -901,9 +901,9 @@ public:
 
   /// \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,
index 97733d37e37f934af17b673e0dd3213dc2185e65..73d80d92da39e17c5ebbd0e5a1cdb4f04eff6659 100644 (file)
@@ -1650,7 +1650,7 @@ public:
   /// \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 @@ public:
 
   /// 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,
index f0b727531a571f6ff45c78147d25f3ed7267a743..3044504a927a1a8b9425a06c3d6853f31b96fc31 100644 (file)
@@ -836,14 +836,15 @@ private:
 
   /// \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 @@ public:
   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 @@ public:
   /// 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 @@ public:
                                         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);