diff options
Diffstat (limited to 'lldb/source/Plugins/ExpressionParser/Clang/ClangASTSource.h')
| -rw-r--r-- | lldb/source/Plugins/ExpressionParser/Clang/ClangASTSource.h | 118 |
1 files changed, 59 insertions, 59 deletions
diff --git a/lldb/source/Plugins/ExpressionParser/Clang/ClangASTSource.h b/lldb/source/Plugins/ExpressionParser/Clang/ClangASTSource.h index 063d82e1c9e..e12f1c5c770 100644 --- a/lldb/source/Plugins/ExpressionParser/Clang/ClangASTSource.h +++ b/lldb/source/Plugins/ExpressionParser/Clang/ClangASTSource.h @@ -23,7 +23,7 @@ namespace lldb_private { //---------------------------------------------------------------------- -/// @class ClangASTSource ClangASTSource.h "lldb/Expression/ClangASTSource.h" +/// \class ClangASTSource ClangASTSource.h "lldb/Expression/ClangASTSource.h" /// Provider for named objects defined in the debug info for Clang /// /// As Clang parses an expression, it may encounter names that are not defined @@ -40,7 +40,7 @@ public: /// /// Initializes class variables. /// - /// @param[in] target + /// \param[in] target /// A reference to the target containing debug information to use. //------------------------------------------------------------------ ClangASTSource(const lldb::TargetSP &target); @@ -82,13 +82,13 @@ public: /// The work for this function is done by /// void FindExternalVisibleDecls (NameSearchContext &); /// - /// @param[in] DC + /// \param[in] DC /// The DeclContext to register the found Decls in. /// - /// @param[in] Name + /// \param[in] Name /// The name to find entries for. /// - /// @return + /// \return /// Whatever SetExternalVisibleDeclsForName returns. //------------------------------------------------------------------ bool FindExternalVisibleDeclsByName(const clang::DeclContext *DC, @@ -97,14 +97,14 @@ public: //------------------------------------------------------------------ /// Enumerate all Decls in a given lexical context. /// - /// @param[in] DC + /// \param[in] DC /// The DeclContext being searched. /// - /// @param[in] isKindWeWant + /// \param[in] isKindWeWant /// A callback function that returns true given the /// DeclKinds of desired Decls, and false otherwise. /// - /// @param[in] Decls + /// \param[in] Decls /// A vector that is filled in with matching Decls. //------------------------------------------------------------------ void FindExternalLexicalDecls( @@ -115,34 +115,34 @@ public: //------------------------------------------------------------------ /// Specify the layout of the contents of a RecordDecl. /// - /// @param[in] Record + /// \param[in] Record /// The record (in the parser's AST context) that needs to be /// laid out. /// - /// @param[out] Size + /// \param[out] Size /// The total size of the record in bits. /// - /// @param[out] Alignment + /// \param[out] Alignment /// The alignment of the record in bits. /// - /// @param[in] FieldOffsets + /// \param[in] FieldOffsets /// A map that must be populated with pairs of the record's /// fields (in the parser's AST context) and their offsets /// (measured in bits). /// - /// @param[in] BaseOffsets + /// \param[in] BaseOffsets /// A map that must be populated with pairs of the record's /// C++ concrete base classes (in the parser's AST context, /// and only if the record is a CXXRecordDecl and has base /// classes) and their offsets (measured in bytes). /// - /// @param[in] VirtualBaseOffsets + /// \param[in] VirtualBaseOffsets /// A map that must be populated with pairs of the record's /// C++ virtual base classes (in the parser's AST context, /// and only if the record is a CXXRecordDecl and has base /// classes) and their offsets (measured in bytes). /// - /// @return + /// \return /// True <=> the layout is valid. //----------------------------------------------------------------- bool layoutRecordType( @@ -156,7 +156,7 @@ public: //------------------------------------------------------------------ /// Complete a TagDecl. /// - /// @param[in] Tag + /// \param[in] Tag /// The Decl to be completed in place. //------------------------------------------------------------------ void CompleteType(clang::TagDecl *Tag) override; @@ -164,7 +164,7 @@ public: //------------------------------------------------------------------ /// Complete an ObjCInterfaceDecl. /// - /// @param[in] Class + /// \param[in] Class /// The Decl to be completed in place. //------------------------------------------------------------------ void CompleteType(clang::ObjCInterfaceDecl *Class) override; @@ -174,7 +174,7 @@ public: /// setHasExternalVisibleStorage() and setHasExternalLexicalStorage() that /// this object has something to say about undefined names. /// - /// @param[in] ASTConsumer + /// \param[in] ASTConsumer /// Unused. //------------------------------------------------------------------ void StartTranslationUnit(clang::ASTConsumer *Consumer) override; @@ -187,13 +187,13 @@ public: /// Look up the modules containing a given namespace and put the appropriate /// entries in the namespace map. /// - /// @param[in] namespace_map + /// \param[in] namespace_map /// The map to be completed. /// - /// @param[in] name + /// \param[in] name /// The name of the namespace to be found. /// - /// @param[in] parent_map + /// \param[in] parent_map /// The map for the namespace's parent namespace, if there is /// one. //------------------------------------------------------------------ @@ -212,7 +212,7 @@ public: //------------------------------------------------------------------ /// The worker function for FindExternalVisibleDeclsByName. /// - /// @param[in] context + /// \param[in] context /// The NameSearchContext to use when filing results. //------------------------------------------------------------------ virtual void FindExternalVisibleDecls(NameSearchContext &context); @@ -228,7 +228,7 @@ public: bool GetLookupsEnabled() { return m_lookups_enabled; } //---------------------------------------------------------------------- - /// @class ClangASTSourceProxy ClangASTSource.h + /// \class ClangASTSourceProxy ClangASTSource.h /// "lldb/Expression/ClangASTSource.h" Proxy for ClangASTSource /// /// Clang AST contexts like to own their AST sources, so this is a state- @@ -298,10 +298,10 @@ protected: /// Look for the complete version of an Objective-C interface, and return it /// if found. /// - /// @param[in] interface_decl + /// \param[in] interface_decl /// An ObjCInterfaceDecl that may not be the complete one. /// - /// @return + /// \return /// NULL if the complete interface couldn't be found; /// the complete interface otherwise. //------------------------------------------------------------------ @@ -312,16 +312,16 @@ protected: /// Find all entities matching a given name in a given module, using a /// NameSearchContext to make Decls for them. /// - /// @param[in] context + /// \param[in] context /// The NameSearchContext that can construct Decls for this name. /// - /// @param[in] module + /// \param[in] module /// If non-NULL, the module to query. /// - /// @param[in] namespace_decl + /// \param[in] namespace_decl /// If valid and module is non-NULL, the parent namespace. /// - /// @param[in] current_id + /// \param[in] current_id /// The ID for the current FindExternalVisibleDecls invocation, /// for logging purposes. //------------------------------------------------------------------ @@ -333,7 +333,7 @@ protected: //------------------------------------------------------------------ /// Find all Objective-C methods matching a given selector. /// - /// @param[in] context + /// \param[in] context /// The NameSearchContext that can construct Decls for this name. /// Its m_decl_name contains the selector and its m_decl_context /// is the containing object. @@ -343,7 +343,7 @@ protected: //------------------------------------------------------------------ /// Find all Objective-C properties and ivars with a given name. /// - /// @param[in] context + /// \param[in] context /// The NameSearchContext that can construct Decls for this name. /// Its m_decl_name contains the name and its m_decl_context /// is the containing object. @@ -354,17 +354,17 @@ protected: /// A wrapper for ClangASTContext::CopyType that sets a flag that /// indicates that we should not respond to queries during import. /// - /// @param[in] dest_context + /// \param[in] dest_context /// The target AST context, typically the parser's AST context. /// - /// @param[in] source_context + /// \param[in] source_context /// The source AST context, typically the AST context of whatever /// symbol file the type was found in. /// - /// @param[in] src_type + /// \param[in] src_type /// The source type. /// - /// @return + /// \return /// The imported type. //------------------------------------------------------------------ CompilerType GuardedCopyType(const CompilerType &src_type); @@ -373,13 +373,13 @@ public: //------------------------------------------------------------------ /// Returns true if a name should be ignored by name lookup. /// - /// @param[in] name + /// \param[in] name /// The name to be considered. /// - /// @param[in] ignore_all_dollar_nmmes + /// \param[in] ignore_all_dollar_nmmes /// True if $-names of all sorts should be ignored. /// - /// @return + /// \return /// True if the name is one of a class of names that are ignored by /// global lookup for performance reasons. //------------------------------------------------------------------ @@ -389,10 +389,10 @@ public: //------------------------------------------------------------------ /// Copies a single Decl into the parser's AST context. /// - /// @param[in] src_decl + /// \param[in] src_decl /// The Decl to copy. /// - /// @return + /// \return /// A copy of the Decl in m_ast_context, or NULL if the copy failed. //------------------------------------------------------------------ clang::Decl *CopyDecl(clang::Decl *src_decl); @@ -400,17 +400,17 @@ public: //------------------------------------------------------------------ /// Copies a single Type to the target of the given ExternalASTMerger. /// - /// @param[in] src_context + /// \param[in] src_context /// The ASTContext containing the type. /// - /// @param[in] merger + /// \param[in] merger /// The merger to use. This isn't just *m_merger_up because it might be /// the persistent AST context's merger. /// - /// @param[in] type + /// \param[in] type /// The type to copy. /// - /// @return + /// \return /// A copy of the Type in the merger's target context. //------------------------------------------------------------------ clang::QualType CopyTypeWithMerger(clang::ASTContext &src_context, @@ -420,16 +420,16 @@ public: //------------------------------------------------------------------ /// Determined the origin of a single Decl, if it can be found. /// - /// @param[in] decl + /// \param[in] decl /// The Decl whose origin is to be found. /// - /// @param[out] original_decl + /// \param[out] original_decl /// A pointer whose target is filled in with the original Decl. /// - /// @param[in] original_ctx + /// \param[in] original_ctx /// A pointer whose target is filled in with the original's ASTContext. /// - /// @return + /// \return /// True if lookup succeeded; false otherwise. //------------------------------------------------------------------ bool ResolveDeclOrigin(const clang::Decl *decl, clang::Decl **original_decl, @@ -471,7 +471,7 @@ protected: }; //---------------------------------------------------------------------- -/// @class NameSearchContext ClangASTSource.h +/// \class NameSearchContext ClangASTSource.h /// "lldb/Expression/ClangASTSource.h" Container for all objects relevant to a /// single name lookup /// @@ -508,17 +508,17 @@ struct NameSearchContext { /// /// Initializes class variables. /// - /// @param[in] astSource + /// \param[in] astSource /// A reference to the AST source making a request. /// - /// @param[in] decls + /// \param[in] decls /// A reference to a list into which new Decls will be placed. This /// list is typically empty when the function is called. /// - /// @param[in] name + /// \param[in] name /// The name being searched for (always an Identifier). /// - /// @param[in] dc + /// \param[in] dc /// The DeclContext to register Decls in. //------------------------------------------------------------------ NameSearchContext(ClangASTSource &astSource, @@ -533,7 +533,7 @@ struct NameSearchContext { /// Create a VarDecl with the name being searched for and the provided type /// and register it in the right places. /// - /// @param[in] type + /// \param[in] type /// The opaque QualType for the VarDecl being registered. //------------------------------------------------------------------ clang::NamedDecl *AddVarDecl(const CompilerType &type); @@ -542,10 +542,10 @@ struct NameSearchContext { /// Create a FunDecl with the name being searched for and the provided type /// and register it in the right places. /// - /// @param[in] type + /// \param[in] type /// The opaque QualType for the FunDecl being registered. /// - /// @param[in] extern_c + /// \param[in] extern_c /// If true, build an extern "C" linkage specification for this. //------------------------------------------------------------------ clang::NamedDecl *AddFunDecl(const CompilerType &type, bool extern_c = false); @@ -560,7 +560,7 @@ struct NameSearchContext { /// Create a TypeDecl with the name being searched for and the provided type /// and register it in the right places. /// - /// @param[in] compiler_type + /// \param[in] compiler_type /// The opaque QualType for the TypeDecl being registered. //------------------------------------------------------------------ clang::NamedDecl *AddTypeDecl(const CompilerType &compiler_type); @@ -569,7 +569,7 @@ struct NameSearchContext { /// Add Decls from the provided DeclContextLookupResult to the list of /// results. /// - /// @param[in] result + /// \param[in] result /// The DeclContextLookupResult, usually returned as the result /// of querying a DeclContext. //------------------------------------------------------------------ @@ -578,7 +578,7 @@ struct NameSearchContext { //------------------------------------------------------------------ /// Add a NamedDecl to the list of results. /// - /// @param[in] decl + /// \param[in] decl /// The NamedDecl, usually returned as the result /// of querying a DeclContext. //------------------------------------------------------------------ |
