diff options
author | Dmitri Gribenko <gribozavr@gmail.com> | 2012-09-13 13:11:20 +0000 |
---|---|---|
committer | Dmitri Gribenko <gribozavr@gmail.com> | 2012-09-13 13:11:20 +0000 |
commit | 1824d54df85a462ada812dadda18130f951d40f3 (patch) | |
tree | 5e06f549da274ea2684f6be9cc1d184f34373c46 /include/clang/AST | |
parent | 30c8a1f79f6d0b61235f5c2762c9077af70d426d (diff) |
Fix Doxygen misuse: refer to parameter names in paragraphs correctly (\arg is
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
Diffstat (limited to 'include/clang/AST')
-rw-r--r-- | include/clang/AST/ASTContext.h | 8 | ||||
-rw-r--r-- | include/clang/AST/CharUnits.h | 4 | ||||
-rw-r--r-- | include/clang/AST/Decl.h | 2 | ||||
-rw-r--r-- | include/clang/AST/DeclObjC.h | 2 | ||||
-rw-r--r-- | include/clang/AST/ExternalASTSource.h | 2 | ||||
-rw-r--r-- | include/clang/AST/NSAPI.h | 6 | ||||
-rw-r--r-- | include/clang/AST/SelectorLocationsKind.h | 4 |
7 files changed, 14 insertions, 14 deletions
diff --git a/include/clang/AST/ASTContext.h b/include/clang/AST/ASTContext.h index 5555e97a8c..3c283bc8f5 100644 --- a/include/clang/AST/ASTContext.h +++ b/include/clang/AST/ASTContext.h @@ -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; diff --git a/include/clang/AST/CharUnits.h b/include/clang/AST/CharUnits.h index 5be35826a9..12e74b32be 100644 --- a/include/clang/AST/CharUnits.h +++ b/include/clang/AST/CharUnits.h @@ -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)); diff --git a/include/clang/AST/Decl.h b/include/clang/AST/Decl.h index 5dcc104874..4d0cde8a43 100644 --- a/include/clang/AST/Decl.h +++ b/include/clang/AST/Decl.h @@ -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); diff --git a/include/clang/AST/DeclObjC.h b/include/clang/AST/DeclObjC.h index 6c39f2c3ab..855fe69461 100644 --- a/include/clang/AST/DeclObjC.h +++ b/include/clang/AST/DeclObjC.h @@ -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, diff --git a/include/clang/AST/ExternalASTSource.h b/include/clang/AST/ExternalASTSource.h index 7aedfe2ef6..db2bddb4bf 100644 --- a/include/clang/AST/ExternalASTSource.h +++ b/include/clang/AST/ExternalASTSource.h @@ -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) {} diff --git a/include/clang/AST/NSAPI.h b/include/clang/AST/NSAPI.h index 51ae1daf14..f9fd1f906b 100644 --- a/include/clang/AST/NSAPI.h +++ b/include/clang/AST/NSAPI.h @@ -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; diff --git a/include/clang/AST/SelectorLocationsKind.h b/include/clang/AST/SelectorLocationsKind.h index cd43a5c49c..6d903f820c 100644 --- a/include/clang/AST/SelectorLocationsKind.h +++ b/include/clang/AST/SelectorLocationsKind.h @@ -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, |