diff options
author | Adrian Prantl <aprantl@apple.com> | 2018-05-09 01:00:01 +0000 |
---|---|---|
committer | Adrian Prantl <aprantl@apple.com> | 2018-05-09 01:00:01 +0000 |
commit | 647be32c6048e24f90f470c557e850597e5526c3 (patch) | |
tree | 2be5c01566ec82e55fd30ceedef970efd887b4a5 /tools/libclang/CIndexCodeCompletion.cpp | |
parent | c8ad1ab42f269f29bcf6385446e5b728aff7e4ad (diff) |
Remove \brief commands from doxygen comments.
This is similar to the LLVM change https://reviews.llvm.org/D46290.
We've been running doxygen with the autobrief option for a couple of
years now. This makes the \brief markers into our comments
redundant. Since they are a visual distraction and we don't want to
encourage more \brief markers in new code either, this patch removes
them all.
Patch produced by
for i in $(git grep -l '\@brief'); do perl -pi -e 's/\@brief //g' $i & done
for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done
Differential Revision: https://reviews.llvm.org/D46320
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@331834 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'tools/libclang/CIndexCodeCompletion.cpp')
-rw-r--r-- | tools/libclang/CIndexCodeCompletion.cpp | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/tools/libclang/CIndexCodeCompletion.cpp b/tools/libclang/CIndexCodeCompletion.cpp index ba2c818cca..73f8da1e1b 100644 --- a/tools/libclang/CIndexCodeCompletion.cpp +++ b/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 |