diff options
Diffstat (limited to 'contrib/llvm/tools/clang/include/clang/AST/DeclObjC.h')
| -rw-r--r-- | contrib/llvm/tools/clang/include/clang/AST/DeclObjC.h | 166 |
1 files changed, 83 insertions, 83 deletions
diff --git a/contrib/llvm/tools/clang/include/clang/AST/DeclObjC.h b/contrib/llvm/tools/clang/include/clang/AST/DeclObjC.h index cef7d935370a..c81a5f805fc0 100644 --- a/contrib/llvm/tools/clang/include/clang/AST/DeclObjC.h +++ b/contrib/llvm/tools/clang/include/clang/AST/DeclObjC.h @@ -97,7 +97,7 @@ public: } }; -/// \brief A list of Objective-C protocols, along with the source +/// A list of Objective-C protocols, along with the source /// locations at which they were referenced. class ObjCProtocolList : public ObjCList<ObjCProtocolDecl> { SourceLocation *Locations = nullptr; @@ -156,10 +156,10 @@ private: // Method has a definition. unsigned IsDefined : 1; - /// \brief Method redeclaration in the same interface. + /// Method redeclaration in the same interface. unsigned IsRedeclaration : 1; - /// \brief Is redeclared in the same interface. + /// Is redeclared in the same interface. mutable unsigned HasRedeclaration : 1; // NOTE: VC++ treats enums as signed, avoid using ImplementationControl enum @@ -170,14 +170,14 @@ private: /// in, inout, etc. unsigned objcDeclQualifier : 7; - /// \brief Indicates whether this method has a related result type. + /// Indicates whether this method has a related result type. unsigned RelatedResultType : 1; - /// \brief Whether the locations of the selector identifiers are in a + /// Whether the locations of the selector identifiers are in a /// "standard" position, a enum SelectorLocationsKind. unsigned SelLocsKind : 2; - /// \brief Whether this method overrides any other in the class hierarchy. + /// Whether this method overrides any other in the class hierarchy. /// /// A method is said to override any method in the class's /// base classes, its protocols, or its categories' protocols, that has @@ -186,7 +186,7 @@ private: /// method in the interface or its categories. unsigned IsOverriding : 1; - /// \brief Indicates if the method was a definition but its body was skipped. + /// Indicates if the method was a definition but its body was skipped. unsigned HasSkippedBody : 1; // Return type of this method. @@ -195,7 +195,7 @@ private: // Type source information for the return type. TypeSourceInfo *ReturnTInfo; - /// \brief Array of ParmVarDecls for the formal parameters of this method + /// Array of ParmVarDecls for the formal parameters of this method /// and optionally followed by selector locations. void *ParamsAndSelLocs = nullptr; unsigned NumParams = 0; @@ -241,7 +241,7 @@ private: return getSelLocsKind() != SelLoc_NonStandard; } - /// \brief Get a pointer to the stored selector identifiers locations array. + /// Get a pointer to the stored selector identifiers locations array. /// No locations will be stored if HasStandardSelLocs is true. SourceLocation *getStoredSelLocs() { return reinterpret_cast<SourceLocation*>(getParams() + NumParams); @@ -250,7 +250,7 @@ private: return reinterpret_cast<const SourceLocation*>(getParams() + NumParams); } - /// \brief Get a pointer to the stored selector identifiers locations array. + /// Get a pointer to the stored selector identifiers locations array. /// No locations will be stored if HasStandardSelLocs is true. ParmVarDecl **getParams() { return reinterpret_cast<ParmVarDecl **>(ParamsAndSelLocs); @@ -259,7 +259,7 @@ private: return reinterpret_cast<const ParmVarDecl *const *>(ParamsAndSelLocs); } - /// \brief Get the number of stored selector identifiers locations. + /// Get the number of stored selector identifiers locations. /// No locations will be stored if HasStandardSelLocs is true. unsigned getNumStoredSelLocs() const { if (hasStandardSelLocs()) @@ -271,7 +271,7 @@ private: ArrayRef<ParmVarDecl*> Params, ArrayRef<SourceLocation> SelLocs); - /// \brief A definition will return its interface declaration. + /// A definition will return its interface declaration. /// An interface declaration will return its definition. /// Otherwise it will return itself. ObjCMethodDecl *getNextRedeclarationImpl() override; @@ -301,18 +301,18 @@ public: } void setObjCDeclQualifier(ObjCDeclQualifier QV) { objcDeclQualifier = QV; } - /// \brief Determine whether this method has a result type that is related + /// Determine whether this method has a result type that is related /// to the message receiver's type. bool hasRelatedResultType() const { return RelatedResultType; } - /// \brief Note whether this method has a related result type. + /// Note whether this method has a related result type. void SetRelatedResultType(bool RRT = true) { RelatedResultType = RRT; } - /// \brief True if this is a method redeclaration in the same interface. + /// True if this is a method redeclaration in the same interface. bool isRedeclaration() const { return IsRedeclaration; } void setAsRedeclaration(const ObjCMethodDecl *PrevMethod); - /// \brief Returns the location where the declarator ends. It will be + /// Returns the location where the declarator ends. It will be /// the location of ';' for a method declaration and the location of '{' /// for a method definition. SourceLocation getDeclaratorEndLoc() const { return DeclEndLoc; } @@ -362,7 +362,7 @@ public: void setReturnType(QualType T) { MethodDeclType = T; } SourceRange getReturnTypeSourceRange() const; - /// \brief Determine the type of an expression that sends a message to this + /// Determine the type of an expression that sends a message to this /// function. This replaces the type parameters with the types they would /// get if the receiver was parameterless (e.g. it may replace the type /// parameter with 'id'). @@ -407,7 +407,7 @@ public: NumParams); } - /// \brief Sets the method's parameters and selector source locations. + /// Sets the method's parameters and selector source locations. /// If the method is implicit (not coming from source) \p SelLocs is /// ignored. void setMethodParams(ASTContext &C, @@ -462,7 +462,7 @@ public: bool isDefined() const { return IsDefined; } void setDefined(bool isDefined) { IsDefined = isDefined; } - /// \brief Whether this method overrides any other in the class hierarchy. + /// Whether this method overrides any other in the class hierarchy. /// /// A method is said to override any method in the class's /// base classes, its protocols, or its categories' protocols, that has @@ -472,7 +472,7 @@ public: bool isOverriding() const { return IsOverriding; } void setOverriding(bool isOverriding) { IsOverriding = isOverriding; } - /// \brief Return overridden methods for the given \p Method. + /// Return overridden methods for the given \p Method. /// /// An ObjC method is considered to override any method in the class's /// base classes (and base's categories), its protocols, or its categories' @@ -483,11 +483,11 @@ public: void getOverriddenMethods( SmallVectorImpl<const ObjCMethodDecl *> &Overridden) const; - /// \brief True if the method was a definition but its body was skipped. + /// True if the method was a definition but its body was skipped. bool hasSkippedBody() const { return HasSkippedBody; } void setHasSkippedBody(bool Skipped = true) { HasSkippedBody = Skipped; } - /// \brief Returns the property associated with this method's selector. + /// Returns the property associated with this method's selector. /// /// Note that even if this particular method is not marked as a property /// accessor, it is still possible for it to match a property declared in a @@ -520,10 +520,10 @@ public: bool isDesignatedInitializerForTheInterface( const ObjCMethodDecl **InitMethod = nullptr) const; - /// \brief Determine whether this method has a body. + /// Determine whether this method has a body. bool hasBody() const override { return Body.isValid(); } - /// \brief Retrieve the body of this method, if it has one. + /// Retrieve the body of this method, if it has one. Stmt *getBody() const override; void setLazyBody(uint64_t Offset) { Body = Offset; } @@ -531,7 +531,7 @@ public: CompoundStmt *getCompoundBody() { return (CompoundStmt*)getBody(); } void setBody(Stmt *B) { Body = B; } - /// \brief Returns whether this specific method is a definition. + /// Returns whether this specific method is a definition. bool isThisDeclarationADefinition() const { return hasBody(); } // Implement isa/cast/dyncast/etc. @@ -737,7 +737,7 @@ enum class ObjCPropertyQueryKind : uint8_t { OBJC_PR_query_class }; -/// \brief Represents one property declaration in an Objective-C interface. +/// Represents one property declaration in an Objective-C interface. /// /// For example: /// \code{.mm} @@ -770,7 +770,7 @@ public: }; enum { - /// \brief Number of bits fitting all the property attributes. + /// Number of bits fitting all the property attributes. NumPropertyAttrsBits = 15 }; @@ -1163,7 +1163,7 @@ public: } }; -/// \brief Represents an ObjC class declaration. +/// Represents an ObjC class declaration. /// /// For example: /// @@ -1197,7 +1197,7 @@ class ObjCInterfaceDecl : public ObjCContainerDecl mutable const Type *TypeForDecl = nullptr; struct DefinitionData { - /// \brief The definition of this class, for quick access from any + /// The definition of this class, for quick access from any /// declaration. ObjCInterfaceDecl *Definition = nullptr; @@ -1210,7 +1210,7 @@ class ObjCInterfaceDecl : public ObjCContainerDecl /// Protocols reference in both the \@interface and class extensions. ObjCList<ObjCProtocolDecl> AllReferencedProtocols; - /// \brief List of categories and class extensions defined for this class. + /// List of categories and class extensions defined for this class. /// /// Categories are stored as a linked list in the AST, since the categories /// and class extensions come long after the initial interface declaration, @@ -1221,11 +1221,11 @@ class ObjCInterfaceDecl : public ObjCContainerDecl /// extensions and implementation. This list is built lazily. ObjCIvarDecl *IvarList = nullptr; - /// \brief Indicates that the contents of this Objective-C class will be + /// Indicates that the contents of this Objective-C class will be /// completed by the external AST source when required. mutable unsigned ExternallyCompleted : 1; - /// \brief Indicates that the ivar cache does not yet include ivars + /// Indicates that the ivar cache does not yet include ivars /// declared in the implementation. mutable unsigned IvarListMissingImplementation : 1; @@ -1248,7 +1248,7 @@ class ObjCInterfaceDecl : public ObjCContainerDecl /// One of the \c InheritedDesignatedInitializersState enumeratos. mutable unsigned InheritedDesignatedInitializers : 2; - /// \brief The location of the last location in this declaration, before + /// The location of the last location in this declaration, before /// the properties/methods. For example, this will be the '>', '}', or /// identifier, SourceLocation EndLoc; @@ -1262,7 +1262,7 @@ class ObjCInterfaceDecl : public ObjCContainerDecl /// The type parameters associated with this class, if any. ObjCTypeParamList *TypeParamList = nullptr; - /// \brief Contains a pointer to the data associated with this class, + /// Contains a pointer to the data associated with this class, /// which will be NULL if this class has not yet been defined. /// /// The bit indicates when we don't need to check for out-of-date @@ -1283,7 +1283,7 @@ class ObjCInterfaceDecl : public ObjCContainerDecl return *Data.getPointer(); } - /// \brief Allocate the definition data for this class. + /// Allocate the definition data for this class. void allocateDefinitionData(); using redeclarable_base = Redeclarable<ObjCInterfaceDecl>; @@ -1338,7 +1338,7 @@ public: return SourceRange(getAtStartLoc(), getLocation()); } - /// \brief Indicate that this Objective-C class is complete, but that + /// Indicate that this Objective-C class is complete, but that /// the external AST source will be responsible for filling in its contents /// when a complete class is required. void setExternallyCompleted(); @@ -1544,13 +1544,13 @@ public: isDesignatedInitializer(Selector Sel, const ObjCMethodDecl **InitMethod = nullptr) const; - /// \brief Determine whether this particular declaration of this class is + /// Determine whether this particular declaration of this class is /// actually also a definition. bool isThisDeclarationADefinition() const { return getDefinition() == this; } - /// \brief Determine whether this class has been defined. + /// Determine whether this class has been defined. bool hasDefinition() const { // If the name of this class is out-of-date, bring it up-to-date, which // might bring in a definition. @@ -1562,21 +1562,21 @@ public: return Data.getPointer(); } - /// \brief Retrieve the definition of this class, or NULL if this class + /// Retrieve the definition of this class, or NULL if this class /// has been forward-declared (with \@class) but not yet defined (with /// \@interface). ObjCInterfaceDecl *getDefinition() { return hasDefinition()? Data.getPointer()->Definition : nullptr; } - /// \brief Retrieve the definition of this class, or NULL if this class + /// Retrieve the definition of this class, or NULL if this class /// has been forward-declared (with \@class) but not yet defined (with /// \@interface). const ObjCInterfaceDecl *getDefinition() const { return hasDefinition()? Data.getPointer()->Definition : nullptr; } - /// \brief Starts the definition of this Objective-C class, taking it from + /// Starts the definition of this Objective-C class, taking it from /// a forward declaration (\@class) to a definition (\@interface). void startDefinition(); @@ -1608,7 +1608,7 @@ public: data().SuperClassTInfo = superClass; } - /// \brief Iterator that walks over the list of categories, filtering out + /// Iterator that walks over the list of categories, filtering out /// those that do not meet specific criteria. /// /// This class template is used for the various permutations of category @@ -1655,13 +1655,13 @@ public: }; private: - /// \brief Test whether the given category is visible. + /// Test whether the given category is visible. /// /// Used in the \c visible_categories_iterator. static bool isVisibleCategory(ObjCCategoryDecl *Cat); public: - /// \brief Iterator that walks over the list of categories and extensions + /// Iterator that walks over the list of categories and extensions /// that are visible, i.e., not hidden in a non-imported submodule. using visible_categories_iterator = filtered_category_iterator<isVisibleCategory>; @@ -1674,30 +1674,30 @@ public: visible_categories_end()); } - /// \brief Retrieve an iterator to the beginning of the visible-categories + /// Retrieve an iterator to the beginning of the visible-categories /// list. visible_categories_iterator visible_categories_begin() const { return visible_categories_iterator(getCategoryListRaw()); } - /// \brief Retrieve an iterator to the end of the visible-categories list. + /// Retrieve an iterator to the end of the visible-categories list. visible_categories_iterator visible_categories_end() const { return visible_categories_iterator(); } - /// \brief Determine whether the visible-categories list is empty. + /// Determine whether the visible-categories list is empty. bool visible_categories_empty() const { return visible_categories_begin() == visible_categories_end(); } private: - /// \brief Test whether the given category... is a category. + /// Test whether the given category... is a category. /// /// Used in the \c known_categories_iterator. static bool isKnownCategory(ObjCCategoryDecl *) { return true; } public: - /// \brief Iterator that walks over all of the known categories and + /// Iterator that walks over all of the known categories and /// extensions, including those that are hidden. using known_categories_iterator = filtered_category_iterator<isKnownCategory>; using known_categories_range = @@ -1708,30 +1708,30 @@ public: known_categories_end()); } - /// \brief Retrieve an iterator to the beginning of the known-categories + /// Retrieve an iterator to the beginning of the known-categories /// list. known_categories_iterator known_categories_begin() const { return known_categories_iterator(getCategoryListRaw()); } - /// \brief Retrieve an iterator to the end of the known-categories list. + /// Retrieve an iterator to the end of the known-categories list. known_categories_iterator known_categories_end() const { return known_categories_iterator(); } - /// \brief Determine whether the known-categories list is empty. + /// Determine whether the known-categories list is empty. bool known_categories_empty() const { return known_categories_begin() == known_categories_end(); } private: - /// \brief Test whether the given category is a visible extension. + /// Test whether the given category is a visible extension. /// /// Used in the \c visible_extensions_iterator. static bool isVisibleExtension(ObjCCategoryDecl *Cat); public: - /// \brief Iterator that walks over all of the visible extensions, skipping + /// Iterator that walks over all of the visible extensions, skipping /// any that are known but hidden. using visible_extensions_iterator = filtered_category_iterator<isVisibleExtension>; @@ -1744,24 +1744,24 @@ public: visible_extensions_end()); } - /// \brief Retrieve an iterator to the beginning of the visible-extensions + /// Retrieve an iterator to the beginning of the visible-extensions /// list. visible_extensions_iterator visible_extensions_begin() const { return visible_extensions_iterator(getCategoryListRaw()); } - /// \brief Retrieve an iterator to the end of the visible-extensions list. + /// Retrieve an iterator to the end of the visible-extensions list. visible_extensions_iterator visible_extensions_end() const { return visible_extensions_iterator(); } - /// \brief Determine whether the visible-extensions list is empty. + /// Determine whether the visible-extensions list is empty. bool visible_extensions_empty() const { return visible_extensions_begin() == visible_extensions_end(); } private: - /// \brief Test whether the given category is an extension. + /// Test whether the given category is an extension. /// /// Used in the \c known_extensions_iterator. static bool isKnownExtension(ObjCCategoryDecl *Cat); @@ -1771,7 +1771,7 @@ public: friend class ASTDeclWriter; friend class ASTReader; - /// \brief Iterator that walks over all of the known extensions. + /// Iterator that walks over all of the known extensions. using known_extensions_iterator = filtered_category_iterator<isKnownExtension>; using known_extensions_range = @@ -1782,23 +1782,23 @@ public: known_extensions_end()); } - /// \brief Retrieve an iterator to the beginning of the known-extensions + /// Retrieve an iterator to the beginning of the known-extensions /// list. known_extensions_iterator known_extensions_begin() const { return known_extensions_iterator(getCategoryListRaw()); } - /// \brief Retrieve an iterator to the end of the known-extensions list. + /// Retrieve an iterator to the end of the known-extensions list. known_extensions_iterator known_extensions_end() const { return known_extensions_iterator(); } - /// \brief Determine whether the known-extensions list is empty. + /// Determine whether the known-extensions list is empty. bool known_extensions_empty() const { return known_extensions_begin() == known_extensions_end(); } - /// \brief Retrieve the raw pointer to the start of the category/extension + /// Retrieve the raw pointer to the start of the category/extension /// list. ObjCCategoryDecl* getCategoryListRaw() const { // FIXME: Should make sure no callers ever do this. @@ -1811,7 +1811,7 @@ public: return data().CategoryList; } - /// \brief Set the raw pointer to the start of the category/extension + /// Set the raw pointer to the start of the category/extension /// list. void setCategoryListRaw(ObjCCategoryDecl *category) { data().CategoryList = category; @@ -1874,7 +1874,7 @@ public: ObjCInterfaceDecl *lookupInheritedClass(const IdentifierInfo *ICName); - /// \brief Lookup a method in the classes implementation hierarchy. + /// Lookup a method in the classes implementation hierarchy. ObjCMethodDecl *lookupPrivateMethod(const Selector &Sel, bool Instance=true) const; @@ -1882,7 +1882,7 @@ public: return lookupPrivateMethod(Sel, false); } - /// \brief Lookup a setter or getter in the class hierarchy, + /// Lookup a setter or getter in the class hierarchy, /// including in all categories except for category passed /// as argument. ObjCMethodDecl *lookupPropertyAccessor(const Selector Sel, @@ -1988,7 +1988,7 @@ public: static ObjCIvarDecl *CreateDeserialized(ASTContext &C, unsigned ID); - /// \brief Return the class interface that this ivar is logically contained + /// Return the class interface that this ivar is logically contained /// in; this is either the interface where the ivar was declared, or the /// interface the ivar is conceptually a part of in the case of synthesized /// ivars. @@ -2027,7 +2027,7 @@ private: unsigned Synthesized : 1; }; -/// \brief Represents a field declaration created by an \@defs(...). +/// Represents a field declaration created by an \@defs(...). class ObjCAtDefsFieldDecl : public FieldDecl { ObjCAtDefsFieldDecl(DeclContext *DC, SourceLocation StartLoc, SourceLocation IdLoc, IdentifierInfo *Id, @@ -2051,7 +2051,7 @@ public: static bool classofKind(Kind K) { return K == ObjCAtDefsField; } }; -/// \brief Represents an Objective-C protocol declaration. +/// Represents an Objective-C protocol declaration. /// /// Objective-C protocols declare a pure abstract type (i.e., no instance /// variables are permitted). Protocols originally drew inspiration from @@ -2083,14 +2083,14 @@ public: class ObjCProtocolDecl : public ObjCContainerDecl, public Redeclarable<ObjCProtocolDecl> { struct DefinitionData { - // \brief The declaration that defines this protocol. + // The declaration that defines this protocol. ObjCProtocolDecl *Definition; - /// \brief Referenced protocols + /// Referenced protocols ObjCProtocolList ReferencedProtocols; }; - /// \brief Contains a pointer to the data associated with this class, + /// Contains a pointer to the data associated with this class, /// which will be NULL if this class has not yet been defined. /// /// The bit indicates when we don't need to check for out-of-date @@ -2213,7 +2213,7 @@ public: return lookupMethod(Sel, false/*isInstance*/); } - /// \brief Determine whether this protocol has a definition. + /// Determine whether this protocol has a definition. bool hasDefinition() const { // If the name of this protocol is out-of-date, bring it up-to-date, which // might bring in a definition. @@ -2225,23 +2225,23 @@ public: return Data.getPointer(); } - /// \brief Retrieve the definition of this protocol, if any. + /// Retrieve the definition of this protocol, if any. ObjCProtocolDecl *getDefinition() { return hasDefinition()? Data.getPointer()->Definition : nullptr; } - /// \brief Retrieve the definition of this protocol, if any. + /// Retrieve the definition of this protocol, if any. const ObjCProtocolDecl *getDefinition() const { return hasDefinition()? Data.getPointer()->Definition : nullptr; } - /// \brief Determine whether this particular declaration is also the + /// Determine whether this particular declaration is also the /// definition. bool isThisDeclarationADefinition() const { return getDefinition() == this; } - /// \brief Starts the definition of this Objective-C protocol. + /// Starts the definition of this Objective-C protocol. void startDefinition(); /// Produce a name to be used for protocol's metadata. It comes either via @@ -2310,7 +2310,7 @@ class ObjCCategoryDecl : public ObjCContainerDecl { /// FIXME: this should not be a singly-linked list. Move storage elsewhere. ObjCCategoryDecl *NextClassCategory = nullptr; - /// \brief The location of the category name in this declaration. + /// The location of the category name in this declaration. SourceLocation CategoryNameLoc; /// class extension may have private ivars. @@ -2400,7 +2400,7 @@ public: ObjCCategoryDecl *getNextClassCategory() const { return NextClassCategory; } - /// \brief Retrieve the pointer to the next stored category (or extension), + /// Retrieve the pointer to the next stored category (or extension), /// which may be hidden. ObjCCategoryDecl *getNextClassCategoryRaw() const { return NextClassCategory; @@ -2578,7 +2578,7 @@ class ObjCImplementationDecl : public ObjCImplDecl { SourceLocation IvarRBraceLoc; /// Support for ivar initialization. - /// \brief The arguments used to initialize the ivars + /// The arguments used to initialize the ivars LazyCXXCtorInitializersPtr IvarInitializers; unsigned NumIvarInitializers = 0; @@ -2694,7 +2694,7 @@ public: return getIdentifier()->getName(); } - /// @brief Get the name of the class associated with this interface. + /// Get the name of the class associated with this interface. // // FIXME: Move to StringRef API. std::string getNameAsString() const { @@ -2785,7 +2785,7 @@ public: private: SourceLocation AtLoc; // location of \@synthesize or \@dynamic - /// \brief For \@synthesize, the location of the ivar, if it was written in + /// For \@synthesize, the location of the ivar, if it was written in /// the source code. /// /// \code @@ -2854,7 +2854,7 @@ public: this->IvarLoc = IvarLoc; } - /// \brief For \@synthesize, returns true if an ivar name was explicitly + /// For \@synthesize, returns true if an ivar name was explicitly /// specified. /// /// \code |