diff options
Diffstat (limited to 'clang/tools/libclang')
-rw-r--r-- | clang/tools/libclang/CIndex.cpp | 28 | ||||
-rw-r--r-- | clang/tools/libclang/CIndexCodeCompletion.cpp | 38 | ||||
-rw-r--r-- | clang/tools/libclang/CIndexDiagnostic.h | 42 | ||||
-rw-r--r-- | clang/tools/libclang/CIndexHigh.cpp | 4 | ||||
-rw-r--r-- | clang/tools/libclang/CIndexer.h | 22 | ||||
-rw-r--r-- | clang/tools/libclang/CLog.h | 4 | ||||
-rw-r--r-- | clang/tools/libclang/CXCursor.cpp | 10 | ||||
-rw-r--r-- | clang/tools/libclang/CXCursor.h | 80 | ||||
-rw-r--r-- | clang/tools/libclang/CXIndexDataConsumer.h | 2 | ||||
-rw-r--r-- | clang/tools/libclang/CXLoadedDiagnostic.cpp | 2 | ||||
-rw-r--r-- | clang/tools/libclang/CXLoadedDiagnostic.h | 22 | ||||
-rw-r--r-- | clang/tools/libclang/CXSourceLocation.h | 8 | ||||
-rw-r--r-- | clang/tools/libclang/CXString.h | 20 | ||||
-rw-r--r-- | clang/tools/libclang/CursorVisitor.h | 24 | ||||
-rw-r--r-- | clang/tools/libclang/Index_Internal.h | 8 | ||||
-rw-r--r-- | clang/tools/libclang/Indexing.cpp | 2 |
16 files changed, 158 insertions, 158 deletions
diff --git a/clang/tools/libclang/CIndex.cpp b/clang/tools/libclang/CIndex.cpp index 64e14351f1c..c348506545d 100644 --- a/clang/tools/libclang/CIndex.cpp +++ b/clang/tools/libclang/CIndex.cpp @@ -103,7 +103,7 @@ cxtu::CXTUOwner::~CXTUOwner() { clang_disposeTranslationUnit(TU); } -/// \brief Compare two source ranges to determine their relative position in +/// Compare two source ranges to determine their relative position in /// the translation unit. static RangeComparisonResult RangeCompare(SourceManager &SM, SourceRange R1, @@ -119,7 +119,7 @@ static RangeComparisonResult RangeCompare(SourceManager &SM, return RangeOverlap; } -/// \brief Determine if a source location falls within, before, or after a +/// Determine if a source location falls within, before, or after a /// a given source range. static RangeComparisonResult LocationCompare(SourceManager &SM, SourceLocation L, SourceRange R) { @@ -134,7 +134,7 @@ static RangeComparisonResult LocationCompare(SourceManager &SM, return RangeOverlap; } -/// \brief Translate a Clang source range into a CIndex source range. +/// Translate a Clang source range into a CIndex source range. /// /// Clang internally represents ranges where the end location points to the /// start of the token at the end. However, for external clients it is more @@ -178,7 +178,7 @@ RangeComparisonResult CursorVisitor::CompareRegionOfInterest(SourceRange R) { return RangeCompare(AU->getSourceManager(), R, RegionOfInterest); } -/// \brief Visit the given cursor and, if requested by the visitor, +/// Visit the given cursor and, if requested by the visitor, /// its children. /// /// \param Cursor the cursor to visit. @@ -482,7 +482,7 @@ bool CursorVisitor::visitPreprocessedEntities(InputIterator First, return false; } -/// \brief Visit the children of the given cursor. +/// Visit the children of the given cursor. /// /// \returns true if the visitation should be aborted, false if it /// should continue. @@ -799,7 +799,7 @@ static bool HasTrailingReturnType(FunctionDecl *ND) { return false; } -/// \brief Compare two base or member initializers based on their source order. +/// Compare two base or member initializers based on their source order. static int CompareCXXCtorInitializers(CXXCtorInitializer *const *X, CXXCtorInitializer *const *Y) { return (*X)->getSourceOrder() - (*Y)->getSourceOrder(); @@ -2119,7 +2119,7 @@ void EnqueueVisitor::EnqueueChildren(const Stmt *S) { namespace { class OMPClauseEnqueue : public ConstOMPClauseVisitor<OMPClauseEnqueue> { EnqueueVisitor *Visitor; - /// \brief Process clauses with list of variables. + /// Process clauses with list of variables. template <typename T> void VisitOMPClauseList(T *Node); public: @@ -5953,7 +5953,7 @@ static SourceRange getRawCursorExtent(CXCursor C) { return SourceRange(); } -/// \brief Retrieves the "raw" cursor extent, which is then extended to include +/// Retrieves the "raw" cursor extent, which is then extended to include /// the decl-specifier-seq for declarations. static SourceRange getFullCursorExtent(CXCursor C, SourceManager &SrcMgr) { if (clang_isDeclaration(C.kind)) { @@ -6763,7 +6763,7 @@ public: bool postVisitChildren(CXCursor cursor); void AnnotateTokens(); - /// \brief Determine whether the annotator saw any cursors that have + /// Determine whether the annotator saw any cursors that have /// context-sensitive keywords. bool hasContextSensitiveKeywords() const { return HasContextSensitiveKeywords; @@ -6788,7 +6788,7 @@ static inline void updateCursorAnnotation(CXCursor &Cursor, Cursor = updateC; } -/// \brief It annotates and advances tokens with a cursor until the comparison +/// It annotates and advances tokens with a cursor until the comparison //// between the cursor location and the source range is the same as /// \arg compResult. /// @@ -6813,7 +6813,7 @@ void AnnotateTokensWorker::annotateAndAdvanceTokens(CXCursor updateC, } } -/// \brief Special annotation handling for macro argument tokens. +/// Special annotation handling for macro argument tokens. /// \returns true if it advanced beyond all macro tokens, false otherwise. bool AnnotateTokensWorker::annotateAndAdvanceFunctionMacroTokens( CXCursor updateC, @@ -7057,7 +7057,7 @@ static bool AnnotateTokensPostChildrenVisitor(CXCursor cursor, namespace { -/// \brief Uses the macro expansions in the preprocessing record to find +/// Uses the macro expansions in the preprocessing record to find /// and mark tokens that are macro arguments. This info is used by the /// AnnotateTokensWorker. class MarkMacroArgTokensVisitor { @@ -7132,7 +7132,7 @@ MarkMacroArgTokensVisitorDelegate(CXCursor cursor, CXCursor parent, parent); } -/// \brief Used by \c annotatePreprocessorTokens. +/// Used by \c annotatePreprocessorTokens. /// \returns true if lexing was finished, false otherwise. static bool lexNext(Lexer &Lex, Token &Tok, unsigned &NextIdx, unsigned NumTokens) { @@ -7706,7 +7706,7 @@ CXTLSKind clang_getCursorTLSKind(CXCursor cursor) { return CXTLS_None; } - /// \brief If the given cursor is the "templated" declaration + /// If the given cursor is the "templated" declaration /// describing a class or function template, return the class or /// function template. static const Decl *maybeGetTemplateCursor(const Decl *D) { diff --git a/clang/tools/libclang/CIndexCodeCompletion.cpp b/clang/tools/libclang/CIndexCodeCompletion.cpp index ba2c818cca3..73f8da1e1bf 100644 --- a/clang/tools/libclang/CIndexCodeCompletion.cpp +++ b/clang/tools/libclang/CIndexCodeCompletion.cpp @@ -240,7 +240,7 @@ clang_getCompletionBriefComment(CXCompletionString completion_string) { namespace { -/// \brief The CXCodeCompleteResults structure we allocate internally; +/// The CXCodeCompleteResults structure we allocate internally; /// the client only sees the initial CXCodeCompleteResults structure. /// /// Normally, clients of CXString shouldn't care whether or not a CXString is @@ -251,62 +251,62 @@ struct AllocatedCXCodeCompleteResults : public CXCodeCompleteResults { AllocatedCXCodeCompleteResults(IntrusiveRefCntPtr<FileManager> FileMgr); ~AllocatedCXCodeCompleteResults(); - /// \brief Diagnostics produced while performing code completion. + /// Diagnostics produced while performing code completion. SmallVector<StoredDiagnostic, 8> Diagnostics; - /// \brief Allocated API-exposed wrappters for Diagnostics. + /// Allocated API-exposed wrappters for Diagnostics. SmallVector<CXStoredDiagnostic *, 8> DiagnosticsWrappers; IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts; - /// \brief Diag object + /// Diag object IntrusiveRefCntPtr<DiagnosticsEngine> Diag; - /// \brief Language options used to adjust source locations. + /// Language options used to adjust source locations. LangOptions LangOpts; - /// \brief File manager, used for diagnostics. + /// File manager, used for diagnostics. IntrusiveRefCntPtr<FileManager> FileMgr; - /// \brief Source manager, used for diagnostics. + /// Source manager, used for diagnostics. IntrusiveRefCntPtr<SourceManager> SourceMgr; - /// \brief Temporary buffers that will be deleted once we have finished with + /// Temporary buffers that will be deleted once we have finished with /// the code-completion results. SmallVector<const llvm::MemoryBuffer *, 1> TemporaryBuffers; - /// \brief Allocator used to store globally cached code-completion results. + /// Allocator used to store globally cached code-completion results. std::shared_ptr<clang::GlobalCodeCompletionAllocator> CachedCompletionAllocator; - /// \brief Allocator used to store code completion results. + /// Allocator used to store code completion results. std::shared_ptr<clang::GlobalCodeCompletionAllocator> CodeCompletionAllocator; - /// \brief Context under which completion occurred. + /// Context under which completion occurred. enum clang::CodeCompletionContext::Kind ContextKind; - /// \brief A bitfield representing the acceptable completions for the + /// A bitfield representing the acceptable completions for the /// current context. unsigned long long Contexts; - /// \brief The kind of the container for the current context for completions. + /// The kind of the container for the current context for completions. enum CXCursorKind ContainerKind; - /// \brief The USR of the container for the current context for completions. + /// The USR of the container for the current context for completions. std::string ContainerUSR; - /// \brief a boolean value indicating whether there is complete information + /// a boolean value indicating whether there is complete information /// about the container unsigned ContainerIsIncomplete; - /// \brief A string containing the Objective-C selector entered thus far for a + /// A string containing the Objective-C selector entered thus far for a /// message send. std::string Selector; }; } // end anonymous namespace -/// \brief Tracks the number of code-completion result objects that are +/// Tracks the number of code-completion result objects that are /// currently active. /// /// Used for debugging purposes only. @@ -913,7 +913,7 @@ CXString clang_codeCompleteGetObjCSelector(CXCodeCompleteResults *ResultsIn) { return cxstring::createDup(Results->Selector); } -/// \brief Simple utility function that appends a \p New string to the given +/// Simple utility function that appends a \p New string to the given /// \p Old string, using the \p Buffer for storage. /// /// \param Old The string to which we are appending. This parameter will be @@ -937,7 +937,7 @@ static void AppendToString(StringRef &Old, StringRef New, Old = Buffer.str(); } -/// \brief Get the typed-text blocks from the given code-completion string +/// Get the typed-text blocks from the given code-completion string /// and return them as a single string. /// /// \param String The code-completion string whose typed-text blocks will be diff --git a/clang/tools/libclang/CIndexDiagnostic.h b/clang/tools/libclang/CIndexDiagnostic.h index 9f406987ebf..e865df0894a 100644 --- a/clang/tools/libclang/CIndexDiagnostic.h +++ b/clang/tools/libclang/CIndexDiagnostic.h @@ -58,34 +58,34 @@ public: virtual ~CXDiagnosticImpl(); - /// \brief Return the severity of the diagnostic. + /// Return the severity of the diagnostic. virtual CXDiagnosticSeverity getSeverity() const = 0; - /// \brief Return the location of the diagnostic. + /// Return the location of the diagnostic. virtual CXSourceLocation getLocation() const = 0; - /// \brief Return the spelling of the diagnostic. + /// Return the spelling of the diagnostic. virtual CXString getSpelling() const = 0; - /// \brief Return the text for the diagnostic option. + /// Return the text for the diagnostic option. virtual CXString getDiagnosticOption(CXString *Disable) const = 0; - /// \brief Return the category of the diagnostic. + /// Return the category of the diagnostic. virtual unsigned getCategory() const = 0; - /// \brief Return the category string of the diagnostic. + /// Return the category string of the diagnostic. virtual CXString getCategoryText() const = 0; - /// \brief Return the number of source ranges for the diagnostic. + /// Return the number of source ranges for the diagnostic. virtual unsigned getNumRanges() const = 0; - /// \brief Return the source ranges for the diagnostic. + /// Return the source ranges for the diagnostic. virtual CXSourceRange getRange(unsigned Range) const = 0; - /// \brief Return the number of FixIts. + /// Return the number of FixIts. virtual unsigned getNumFixIts() const = 0; - /// \brief Return the FixIt information (source range and inserted text). + /// Return the FixIt information (source range and inserted text). virtual CXString getFixIt(unsigned FixIt, CXSourceRange *ReplacementRange) const = 0; @@ -107,7 +107,7 @@ private: Kind K; }; -/// \brief The storage behind a CXDiagnostic +/// The storage behind a CXDiagnostic struct CXStoredDiagnostic : public CXDiagnosticImpl { const StoredDiagnostic &Diag; const LangOptions &LangOpts; @@ -119,34 +119,34 @@ struct CXStoredDiagnostic : public CXDiagnosticImpl { ~CXStoredDiagnostic() override {} - /// \brief Return the severity of the diagnostic. + /// Return the severity of the diagnostic. CXDiagnosticSeverity getSeverity() const override; - /// \brief Return the location of the diagnostic. + /// Return the location of the diagnostic. CXSourceLocation getLocation() const override; - /// \brief Return the spelling of the diagnostic. + /// Return the spelling of the diagnostic. CXString getSpelling() const override; - /// \brief Return the text for the diagnostic option. + /// Return the text for the diagnostic option. CXString getDiagnosticOption(CXString *Disable) const override; - /// \brief Return the category of the diagnostic. + /// Return the category of the diagnostic. unsigned getCategory() const override; - /// \brief Return the category string of the diagnostic. + /// Return the category string of the diagnostic. CXString getCategoryText() const override; - /// \brief Return the number of source ranges for the diagnostic. + /// Return the number of source ranges for the diagnostic. unsigned getNumRanges() const override; - /// \brief Return the source ranges for the diagnostic. + /// Return the source ranges for the diagnostic. CXSourceRange getRange(unsigned Range) const override; - /// \brief Return the number of FixIts. + /// Return the number of FixIts. unsigned getNumFixIts() const override; - /// \brief Return the FixIt information (source range and inserted text). + /// Return the FixIt information (source range and inserted text). CXString getFixIt(unsigned FixIt, CXSourceRange *ReplacementRange) const override; diff --git a/clang/tools/libclang/CIndexHigh.cpp b/clang/tools/libclang/CIndexHigh.cpp index d4666c2288c..a9cd2cac42e 100644 --- a/clang/tools/libclang/CIndexHigh.cpp +++ b/clang/tools/libclang/CIndexHigh.cpp @@ -65,7 +65,7 @@ struct FindFileIdRefVisitData { return cxtu::getASTUnit(TU)->getASTContext(); } - /// \brief We are looking to find all semantically relevant identifiers, + /// We are looking to find all semantically relevant identifiers, /// so the definition of "canonical" here is different than in the AST, e.g. /// /// \code @@ -129,7 +129,7 @@ private: } // end anonymous namespace. -/// \brief For a macro \arg Loc, returns the file spelling location and sets +/// For a macro \arg Loc, returns the file spelling location and sets /// to \arg isMacroArg whether the spelling resides inside a macro definition or /// a macro argument. static SourceLocation getFileSpellingLoc(SourceManager &SM, diff --git a/clang/tools/libclang/CIndexer.h b/clang/tools/libclang/CIndexer.h index 6c46eed4fb9..3ba35d6db60 100644 --- a/clang/tools/libclang/CIndexer.h +++ b/clang/tools/libclang/CIndexer.h @@ -52,7 +52,7 @@ public: Options(CXGlobalOpt_None), PCHContainerOps(std::move(PCHContainerOps)) { } - /// \brief Whether we only want to see "local" declarations (that did not + /// Whether we only want to see "local" declarations (that did not /// come from a previous precompiled header). If false, we want to see all /// declarations. bool getOnlyLocalDecls() const { return OnlyLocalDecls; } @@ -74,7 +74,7 @@ public: return Options & opt; } - /// \brief Get the path of the clang resource files. + /// Get the path of the clang resource files. const std::string &getClangResourcesPath(); StringRef getClangToolchainPath(); @@ -103,47 +103,47 @@ private: std::string File; }; - /// \brief Return the current size to request for "safety". + /// Return the current size to request for "safety". unsigned GetSafetyThreadStackSize(); - /// \brief Set the current size to request for "safety" (or 0, if safety + /// Set the current size to request for "safety" (or 0, if safety /// threads should not be used). void SetSafetyThreadStackSize(unsigned Value); - /// \brief Execution the given code "safely", using crash recovery or safety + /// Execution the given code "safely", using crash recovery or safety /// threads when possible. /// /// \return False if a crash was detected. bool RunSafely(llvm::CrashRecoveryContext &CRC, llvm::function_ref<void()> Fn, unsigned Size = 0); - /// \brief Set the thread priority to background. + /// Set the thread priority to background. /// FIXME: Move to llvm/Support. void setThreadBackgroundPriority(); - /// \brief Print libclang's resource usage to standard error. + /// Print libclang's resource usage to standard error. void PrintLibclangResourceUsage(CXTranslationUnit TU); namespace cxindex { void printDiagsToStderr(ASTUnit *Unit); - /// \brief If \c MacroDefLoc points at a macro definition with \c II as + /// If \c MacroDefLoc points at a macro definition with \c II as /// its name, this retrieves its MacroInfo. MacroInfo *getMacroInfo(const IdentifierInfo &II, SourceLocation MacroDefLoc, CXTranslationUnit TU); - /// \brief Retrieves the corresponding MacroInfo of a MacroDefinitionRecord. + /// Retrieves the corresponding MacroInfo of a MacroDefinitionRecord. const MacroInfo *getMacroInfo(const MacroDefinitionRecord *MacroDef, CXTranslationUnit TU); - /// \brief If \c Loc resides inside the definition of \c MI and it points at + /// If \c Loc resides inside the definition of \c MI and it points at /// an identifier that has ever been a macro name, this returns the latest /// MacroDefinitionRecord for that name, otherwise it returns NULL. MacroDefinitionRecord *checkForMacroInMacroDefinition(const MacroInfo *MI, SourceLocation Loc, CXTranslationUnit TU); - /// \brief If \c Tok resides inside the definition of \c MI and it points at + /// If \c Tok resides inside the definition of \c MI and it points at /// an identifier that has ever been a macro name, this returns the latest /// MacroDefinitionRecord for that name, otherwise it returns NULL. MacroDefinitionRecord *checkForMacroInMacroDefinition(const MacroInfo *MI, diff --git a/clang/tools/libclang/CLog.h b/clang/tools/libclang/CLog.h index e1d6a57e4a0..a935995a113 100644 --- a/clang/tools/libclang/CLog.h +++ b/clang/tools/libclang/CLog.h @@ -31,7 +31,7 @@ namespace cxindex { class Logger; typedef IntrusiveRefCntPtr<Logger> LogRef; -/// \brief Collects logging output and writes it to stderr when it's destructed. +/// Collects logging output and writes it to stderr when it's destructed. /// Common use case: /// \code /// if (LogRef Log = Logger::make(__func__)) { @@ -90,7 +90,7 @@ public: } } -/// \brief Macros to automate common uses of Logger. Like this: +/// Macros to automate common uses of Logger. Like this: /// \code /// LOG_FUNC_SECTION { /// *Log << "blah"; diff --git a/clang/tools/libclang/CXCursor.cpp b/clang/tools/libclang/CXCursor.cpp index 8fdb921d63f..bce9351b948 100644 --- a/clang/tools/libclang/CXCursor.cpp +++ b/clang/tools/libclang/CXCursor.cpp @@ -1196,19 +1196,19 @@ int clang_Cursor_getNumTemplateArguments(CXCursor C) { } enum CXGetTemplateArgumentStatus { - /** \brief The operation completed successfully */ + /** The operation completed successfully */ CXGetTemplateArgumentStatus_Success = 0, - /** \brief The specified cursor did not represent a FunctionDecl. */ + /** The specified cursor did not represent a FunctionDecl. */ CXGetTemplateArgumentStatus_CursorNotFunctionDecl = -1, - /** \brief The specified cursor was not castable to a FunctionDecl. */ + /** The specified cursor was not castable to a FunctionDecl. */ CXGetTemplateArgumentStatus_BadFunctionDeclCast = -2, - /** \brief A NULL FunctionTemplateSpecializationInfo was retrieved. */ + /** A NULL FunctionTemplateSpecializationInfo was retrieved. */ CXGetTemplateArgumentStatus_NullTemplSpecInfo = -3, - /** \brief An invalid (OOB) argument index was specified */ + /** An invalid (OOB) argument index was specified */ CXGetTemplateArgumentStatus_InvalidIndex = -4 }; diff --git a/clang/tools/libclang/CXCursor.h b/clang/tools/libclang/CXCursor.h index 3407f3b5ff3..a5d9fff2a55 100644 --- a/clang/tools/libclang/CXCursor.h +++ b/clang/tools/libclang/CXCursor.h @@ -58,109 +58,109 @@ CXCursor MakeCXCursor(const clang::Stmt *S, const clang::Decl *Parent, SourceRange RegionOfInterest = SourceRange()); CXCursor MakeCXCursorInvalid(CXCursorKind K, CXTranslationUnit TU = nullptr); -/// \brief Create an Objective-C superclass reference at the given location. +/// Create an Objective-C superclass reference at the given location. CXCursor MakeCursorObjCSuperClassRef(ObjCInterfaceDecl *Super, SourceLocation Loc, CXTranslationUnit TU); -/// \brief Unpack an ObjCSuperClassRef cursor into the interface it references +/// Unpack an ObjCSuperClassRef cursor into the interface it references /// and optionally the location where the reference occurred. std::pair<const ObjCInterfaceDecl *, SourceLocation> getCursorObjCSuperClassRef(CXCursor C); -/// \brief Create an Objective-C protocol reference at the given location. +/// Create an Objective-C protocol reference at the given location. CXCursor MakeCursorObjCProtocolRef(const ObjCProtocolDecl *Proto, SourceLocation Loc, CXTranslationUnit TU); -/// \brief Unpack an ObjCProtocolRef cursor into the protocol it references +/// Unpack an ObjCProtocolRef cursor into the protocol it references /// and optionally the location where the reference occurred. std::pair<const ObjCProtocolDecl *, SourceLocation> getCursorObjCProtocolRef(CXCursor C); -/// \brief Create an Objective-C class reference at the given location. +/// Create an Objective-C class reference at the given location. CXCursor MakeCursorObjCClassRef(const ObjCInterfaceDecl *Class, SourceLocation Loc, CXTranslationUnit TU); -/// \brief Unpack an ObjCClassRef cursor into the class it references +/// Unpack an ObjCClassRef cursor into the class it references /// and optionally the location where the reference occurred. std::pair<const ObjCInterfaceDecl *, SourceLocation> getCursorObjCClassRef(CXCursor C); -/// \brief Create a type reference at the given location. +/// Create a type reference at the given location. CXCursor MakeCursorTypeRef(const TypeDecl *Type, SourceLocation Loc, CXTranslationUnit TU); -/// \brief Unpack a TypeRef cursor into the class it references +/// Unpack a TypeRef cursor into the class it references /// and optionally the location where the reference occurred. std::pair<const TypeDecl *, SourceLocation> getCursorTypeRef(CXCursor C); -/// \brief Create a reference to a template at the given location. +/// Create a reference to a template at the given location. CXCursor MakeCursorTemplateRef(const TemplateDecl *Template, SourceLocation Loc, CXTranslationUnit TU); -/// \brief Unpack a TemplateRef cursor into the template it references and +/// Unpack a TemplateRef cursor into the template it references and /// the location where the reference occurred. std::pair<const TemplateDecl *, SourceLocation> getCursorTemplateRef(CXCursor C); -/// \brief Create a reference to a namespace or namespace alias at the given +/// Create a reference to a namespace or namespace alias at the given /// location. CXCursor MakeCursorNamespaceRef(const NamedDecl *NS, SourceLocation Loc, CXTranslationUnit TU); -/// \brief Unpack a NamespaceRef cursor into the namespace or namespace alias +/// Unpack a NamespaceRef cursor into the namespace or namespace alias /// it references and the location where the reference occurred. std::pair<const NamedDecl *, SourceLocation> getCursorNamespaceRef(CXCursor C); -/// \brief Create a reference to a variable at the given location. +/// Create a reference to a variable at the given location. CXCursor MakeCursorVariableRef(const VarDecl *Var, SourceLocation Loc, CXTranslationUnit TU); -/// \brief Unpack a VariableRef cursor into the variable it references and the +/// Unpack a VariableRef cursor into the variable it references and the /// location where the where the reference occurred. std::pair<const VarDecl *, SourceLocation> getCursorVariableRef(CXCursor C); -/// \brief Create a reference to a field at the given location. +/// Create a reference to a field at the given location. CXCursor MakeCursorMemberRef(const FieldDecl *Field, SourceLocation Loc, CXTranslationUnit TU); -/// \brief Unpack a MemberRef cursor into the field it references and the +/// Unpack a MemberRef cursor into the field it references and the /// location where the reference occurred. std::pair<const FieldDecl *, SourceLocation> getCursorMemberRef(CXCursor C); -/// \brief Create a CXX base specifier cursor. +/// Create a CXX base specifier cursor. CXCursor MakeCursorCXXBaseSpecifier(const CXXBaseSpecifier *B, CXTranslationUnit TU); -/// \brief Unpack a CXXBaseSpecifier cursor into a CXXBaseSpecifier. +/// Unpack a CXXBaseSpecifier cursor into a CXXBaseSpecifier. const CXXBaseSpecifier *getCursorCXXBaseSpecifier(CXCursor C); -/// \brief Create a preprocessing directive cursor. +/// Create a preprocessing directive cursor. CXCursor MakePreprocessingDirectiveCursor(SourceRange Range, CXTranslationUnit TU); -/// \brief Unpack a given preprocessing directive to retrieve its source range. +/// Unpack a given preprocessing directive to retrieve its source range. SourceRange getCursorPreprocessingDirective(CXCursor C); -/// \brief Create a macro definition cursor. +/// Create a macro definition cursor. CXCursor MakeMacroDefinitionCursor(const MacroDefinitionRecord *, CXTranslationUnit TU); -/// \brief Unpack a given macro definition cursor to retrieve its +/// Unpack a given macro definition cursor to retrieve its /// source range. const MacroDefinitionRecord *getCursorMacroDefinition(CXCursor C); -/// \brief Create a macro expansion cursor. +/// Create a macro expansion cursor. CXCursor MakeMacroExpansionCursor(MacroExpansion *, CXTranslationUnit TU); -/// \brief Create a "pseudo" macro expansion cursor, using a macro definition +/// Create a "pseudo" macro expansion cursor, using a macro definition /// and a source location. CXCursor MakeMacroExpansionCursor(MacroDefinitionRecord *, SourceLocation Loc, CXTranslationUnit TU); -/// \brief Wraps a macro expansion cursor and provides a common interface +/// Wraps a macro expansion cursor and provides a common interface /// for a normal macro expansion cursor or a "pseudo" one. /// /// "Pseudo" macro expansion cursors (essentially a macro definition along with @@ -194,46 +194,46 @@ public: SourceRange getSourceRange() const; }; -/// \brief Unpack a given macro expansion cursor to retrieve its info. +/// Unpack a given macro expansion cursor to retrieve its info. static inline MacroExpansionCursor getCursorMacroExpansion(CXCursor C) { return C; } -/// \brief Create an inclusion directive cursor. +/// Create an inclusion directive cursor. CXCursor MakeInclusionDirectiveCursor(InclusionDirective *, CXTranslationUnit TU); -/// \brief Unpack a given inclusion directive cursor to retrieve its +/// Unpack a given inclusion directive cursor to retrieve its /// source range. const InclusionDirective *getCursorInclusionDirective(CXCursor C); -/// \brief Create a label reference at the given location. +/// Create a label reference at the given location. CXCursor MakeCursorLabelRef(LabelStmt *Label, SourceLocation Loc, CXTranslationUnit TU); -/// \brief Unpack a label reference into the label statement it refers to and +/// Unpack a label reference into the label statement it refers to and /// the location of the reference. std::pair<const LabelStmt *, SourceLocation> getCursorLabelRef(CXCursor C); -/// \brief Create a overloaded declaration reference cursor for an expression. +/// Create a overloaded declaration reference cursor for an expression. CXCursor MakeCursorOverloadedDeclRef(const OverloadExpr *E, CXTranslationUnit TU); -/// \brief Create a overloaded declaration reference cursor for a declaration. +/// Create a overloaded declaration reference cursor for a declaration. CXCursor MakeCursorOverloadedDeclRef(const Decl *D, SourceLocation Location, CXTranslationUnit TU); -/// \brief Create a overloaded declaration reference cursor for a template name. +/// Create a overloaded declaration reference cursor for a template name. CXCursor MakeCursorOverloadedDeclRef(TemplateName Template, SourceLocation Location, CXTranslationUnit TU); -/// \brief Internal storage for an overloaded declaration reference cursor; +/// Internal storage for an overloaded declaration reference cursor; typedef llvm::PointerUnion3<const OverloadExpr *, const Decl *, OverloadedTemplateStorage *> OverloadedDeclRefStorage; -/// \brief Unpack an overloaded declaration reference into an expression, +/// Unpack an overloaded declaration reference into an expression, /// declaration, or template name along with the source location. std::pair<OverloadedDeclRefStorage, SourceLocation> getCursorOverloadedDeclRef(CXCursor C); @@ -251,14 +251,14 @@ CXTranslationUnit getCursorTU(CXCursor Cursor); void getOverriddenCursors(CXCursor cursor, SmallVectorImpl<CXCursor> &overridden); -/// \brief Create an opaque pool used for fast generation of overridden +/// Create an opaque pool used for fast generation of overridden /// CXCursor arrays. void *createOverridenCXCursorsPool(); -/// \brief Dispose of the overridden CXCursors pool. +/// Dispose of the overridden CXCursors pool. void disposeOverridenCXCursorsPool(void *pool); -/// \brief Returns a index/location pair for a selector identifier if the cursor +/// Returns a index/location pair for a selector identifier if the cursor /// points to one. std::pair<int, SourceLocation> getSelectorIdentifierIndexAndLoc(CXCursor); static inline int getSelectorIdentifierIndex(CXCursor cursor) { @@ -279,7 +279,7 @@ static inline CXCursor getTypeRefedCallExprCursor(CXCursor cursor) { CXCursor getTypeRefCursor(CXCursor cursor); -/// \brief Generate a USR for \arg D and put it in \arg Buf. +/// Generate a USR for \arg D and put it in \arg Buf. /// \returns true if no USR was computed or the result should be ignored, /// false otherwise. bool getDeclCursorUSR(const Decl *D, SmallVectorImpl<char> &Buf); @@ -290,7 +290,7 @@ inline bool operator!=(CXCursor X, CXCursor Y) { return !(X == Y); } -/// \brief Return true if the cursor represents a declaration that is the +/// Return true if the cursor represents a declaration that is the /// first in a declaration group. bool isFirstInDeclGroup(CXCursor C); diff --git a/clang/tools/libclang/CXIndexDataConsumer.h b/clang/tools/libclang/CXIndexDataConsumer.h index 55a7a1b4104..19e39b281ab 100644 --- a/clang/tools/libclang/CXIndexDataConsumer.h +++ b/clang/tools/libclang/CXIndexDataConsumer.h @@ -260,7 +260,7 @@ public: } unsigned getNumAttrs() const { return (unsigned)CXAttrs.size(); } - /// \brief Retain/Release only useful when we allocate a AttrListInfo from the + /// Retain/Release only useful when we allocate a AttrListInfo from the /// BumpPtrAllocator, and not from the stack; so that we keep a pointer // in the EntityInfo void Retain() { ++ref_cnt; } diff --git a/clang/tools/libclang/CXLoadedDiagnostic.cpp b/clang/tools/libclang/CXLoadedDiagnostic.cpp index 36c3dcabb92..fd6881e03ab 100644 --- a/clang/tools/libclang/CXLoadedDiagnostic.cpp +++ b/clang/tools/libclang/CXLoadedDiagnostic.cpp @@ -47,7 +47,7 @@ public: FileManager FakeFiles; llvm::DenseMap<unsigned, const FileEntry *> Files; - /// \brief Copy the string into our own allocator. + /// Copy the string into our own allocator. const char *copyString(StringRef Blob) { char *mem = Alloc.Allocate<char>(Blob.size() + 1); memcpy(mem, Blob.data(), Blob.size()); diff --git a/clang/tools/libclang/CXLoadedDiagnostic.h b/clang/tools/libclang/CXLoadedDiagnostic.h index 1209d76669f..521ebd84bf1 100644 --- a/clang/tools/libclang/CXLoadedDiagnostic.h +++ b/clang/tools/libclang/CXLoadedDiagnostic.h @@ -27,34 +27,34 @@ public: ~CXLoadedDiagnostic() override; - /// \brief Return the severity of the diagnostic. + /// Return the severity of the diagnostic. CXDiagnosticSeverity getSeverity() const override; - /// \brief Return the location of the diagnostic. + /// Return the location of the diagnostic. CXSourceLocation getLocation() const override; - /// \brief Return the spelling of the diagnostic. + /// Return the spelling of the diagnostic. CXString getSpelling() const override; - /// \brief Return the text for the diagnostic option. + /// Return the text for the diagnostic option. CXString getDiagnosticOption(CXString *Disable) const override; - /// \brief Return the category of the diagnostic. + /// Return the category of the diagnostic. unsigned getCategory() const override; - /// \brief Return the category string of the diagnostic. + /// Return the category string of the diagnostic. CXString getCategoryText() const override; - /// \brief Return the number of source ranges for the diagnostic. + /// Return the number of source ranges for the diagnostic. unsigned getNumRanges() const override; - /// \brief Return the source ranges for the diagnostic. + /// Return the source ranges for the diagnostic. CXSourceRange getRange(unsigned Range) const override; - /// \brief Return the number of FixIts. + /// Return the number of FixIts. unsigned getNumFixIts() const override; - /// \brief Return the FixIt information (source range and inserted text). + /// Return the FixIt information (source range and inserted text). CXString getFixIt(unsigned FixIt, CXSourceRange *ReplacementRange) const override; @@ -62,7 +62,7 @@ public: return D->getKind() == LoadedDiagnosticKind; } - /// \brief Decode the CXSourceLocation into file, line, column, and offset. + /// Decode the CXSourceLocation into file, line, column, and offset. static void decodeLocation(CXSourceLocation location, CXFile *file, unsigned *line, diff --git a/clang/tools/libclang/CXSourceLocation.h b/clang/tools/libclang/CXSourceLocation.h index f0b3f495491..dddc8475906 100644 --- a/clang/tools/libclang/CXSourceLocation.h +++ b/clang/tools/libclang/CXSourceLocation.h @@ -25,7 +25,7 @@ class SourceManager; namespace cxloc { -/// \brief Translate a Clang source location into a CIndex source location. +/// Translate a Clang source location into a CIndex source location. static inline CXSourceLocation translateSourceLocation(const SourceManager &SM, const LangOptions &LangOpts, SourceLocation Loc) { @@ -37,7 +37,7 @@ translateSourceLocation(const SourceManager &SM, const LangOptions &LangOpts, return Result; } -/// \brief Translate a Clang source location into a CIndex source location. +/// Translate a Clang source location into a CIndex source location. static inline CXSourceLocation translateSourceLocation(ASTContext &Context, SourceLocation Loc) { return translateSourceLocation(Context.getSourceManager(), @@ -45,7 +45,7 @@ static inline CXSourceLocation translateSourceLocation(ASTContext &Context, Loc); } -/// \brief Translate a Clang source range into a CIndex source range. +/// Translate a Clang source range into a CIndex source range. /// /// Clang internally represents ranges where the end location points to the /// start of the token at the end. However, for external clients it is more @@ -55,7 +55,7 @@ CXSourceRange translateSourceRange(const SourceManager &SM, const LangOptions &LangOpts, const CharSourceRange &R); -/// \brief Translate a Clang source range into a CIndex source range. +/// Translate a Clang source range into a CIndex source range. static inline CXSourceRange translateSourceRange(ASTContext &Context, SourceRange R) { return translateSourceRange(Context.getSourceManager(), diff --git a/clang/tools/libclang/CXString.h b/clang/tools/libclang/CXString.h index 6473eb2d710..ed192611870 100644 --- a/clang/tools/libclang/CXString.h +++ b/clang/tools/libclang/CXString.h @@ -27,33 +27,33 @@ namespace cxstring { struct CXStringBuf; -/// \brief Create a CXString object for an empty "" string. +/// Create a CXString object for an empty "" string. CXString createEmpty(); -/// \brief Create a CXString object for an NULL string. +/// Create a CXString object for an NULL string. /// /// A NULL string should be used as an "invalid" value in case of errors. CXString createNull(); -/// \brief Create a CXString object from a nul-terminated C string. New +/// Create a CXString object from a nul-terminated C string. New /// CXString may contain a pointer to \p String. /// /// \p String should not be changed by the caller afterwards. CXString createRef(const char *String); -/// \brief Create a CXString object from a nul-terminated C string. New +/// Create a CXString object from a nul-terminated C string. New /// CXString will contain a copy of \p String. /// /// \p String can be changed or freed by the caller. CXString createDup(const char *String); -/// \brief Create a CXString object from a StringRef. New CXString may +/// Create a CXString object from a StringRef. New CXString may /// contain a pointer to the undrelying data of \p String. /// /// \p String should not be changed by the caller afterwards. CXString createRef(StringRef String); -/// \brief Create a CXString object from a StringRef. New CXString will +/// Create a CXString object from a StringRef. New CXString will /// contain a copy of \p String. /// /// \p String can be changed or freed by the caller. @@ -65,12 +65,12 @@ CXString createDup(StringRef String); // If you need to make a copy, call \c createDup(StringRef(String)). CXString createRef(std::string String) = delete; -/// \brief Create a CXString object that is backed by a string buffer. +/// Create a CXString object that is backed by a string buffer. CXString createCXString(CXStringBuf *buf); CXStringSet *createSet(const std::vector<std::string> &Strings); -/// \brief A string pool used for fast allocation/deallocation of strings. +/// A string pool used for fast allocation/deallocation of strings. class CXStringPool { public: ~CXStringPool(); @@ -89,13 +89,13 @@ struct CXStringBuf { CXStringBuf(CXTranslationUnit TU) : TU(TU) {} - /// \brief Return this buffer to the pool. + /// Return this buffer to the pool. void dispose(); }; CXStringBuf *getCXStringBuf(CXTranslationUnit TU); -/// \brief Returns true if the CXString data is managed by a pool. +/// Returns true if the CXString data is managed by a pool. bool isManagedByPool(CXString str); } diff --git a/clang/tools/libclang/CursorVisitor.h b/clang/tools/libclang/CursorVisitor.h index 82f251a348f..f2fb68fab95 100644 --- a/clang/tools/libclang/CursorVisitor.h +++ b/clang/tools/libclang/CursorVisitor.h @@ -55,44 +55,44 @@ class CursorVisitor : public DeclVisitor<CursorVisitor, bool>, public TypeLocVisitor<CursorVisitor, bool> { public: - /// \brief Callback called after child nodes of a cursor have been visited. + /// Callback called after child nodes of a cursor have been visited. /// Return true to break visitation or false to continue. typedef bool (*PostChildrenVisitorTy)(CXCursor cursor, CXClientData client_data); private: - /// \brief The translation unit we are traversing. + /// The translation unit we are traversing. CXTranslationUnit TU; ASTUnit *AU; - /// \brief The parent cursor whose children we are traversing. + /// The parent cursor whose children we are traversing. CXCursor Parent; - /// \brief The declaration that serves at the parent of any statement or + /// The declaration that serves at the parent of any statement or /// expression nodes. const Decl *StmtParent; - /// \brief The visitor function. + /// The visitor function. CXCursorVisitor Visitor; PostChildrenVisitorTy PostChildrenVisitor; - /// \brief The opaque client data, to be passed along to the visitor. + /// The opaque client data, to be passed along to the visitor. CXClientData ClientData; - /// \brief Whether we should visit the preprocessing record entries last, + /// Whether we should visit the preprocessing record entries last, /// after visiting other declarations. bool VisitPreprocessorLast; - /// \brief Whether we should visit declarations or preprocessing record + /// Whether we should visit declarations or preprocessing record /// entries that are #included inside the \arg RegionOfInterest. bool VisitIncludedEntities; - /// \brief When valid, a source range to which the cursor should restrict + /// When valid, a source range to which the cursor should restrict /// its search. SourceRange RegionOfInterest; - /// \brief Whether we should only visit declarations and not preprocessing + /// Whether we should only visit declarations and not preprocessing /// record entries. bool VisitDeclsOnly; @@ -110,7 +110,7 @@ private: using DeclVisitor<CursorVisitor, bool>::Visit; using TypeLocVisitor<CursorVisitor, bool>::Visit; - /// \brief Determine whether this particular source range comes before, comes + /// Determine whether this particular source range comes before, comes /// after, or overlaps the region of interest. /// /// \param R a half-open source range retrieved from the abstract syntax tree. @@ -177,7 +177,7 @@ public: bool Visit(CXCursor Cursor, bool CheckedRegionOfInterest = false); - /// \brief Visit declarations and preprocessed entities for the file region + /// Visit declarations and preprocessed entities for the file region /// designated by \see RegionOfInterest. bool visitFileRegion(); diff --git a/clang/tools/libclang/Index_Internal.h b/clang/tools/libclang/Index_Internal.h index 98f069c8873..fbe3cabf04c 100644 --- a/clang/tools/libclang/Index_Internal.h +++ b/clang/tools/libclang/Index_Internal.h @@ -40,15 +40,15 @@ typedef struct _CXCursorAndRangeVisitorBlock { #endif // !__has_feature(blocks) -/// \brief The result of comparing two source ranges. +/// The result of comparing two source ranges. enum RangeComparisonResult { - /// \brief Either the ranges overlap or one of the ranges is invalid. + /// Either the ranges overlap or one of the ranges is invalid. RangeOverlap, - /// \brief The first range ends before the second range starts. + /// The first range ends before the second range starts. RangeBefore, - /// \brief The first range starts after the second range ends. + /// The first range starts after the second range ends. RangeAfter }; diff --git a/clang/tools/libclang/Indexing.cpp b/clang/tools/libclang/Indexing.cpp index 5722e915207..51cffbd7f2e 100644 --- a/clang/tools/libclang/Indexing.cpp +++ b/clang/tools/libclang/Indexing.cpp @@ -45,7 +45,7 @@ namespace { // Skip Parsed Bodies //===----------------------------------------------------------------------===// -/// \brief A "region" in source code identified by the file/offset of the +/// A "region" in source code identified by the file/offset of the /// preprocessor conditional directive that it belongs to. /// Multiple, non-consecutive ranges can be parts of the same region. /// |