diff options
author | Adrian Prantl <aprantl@apple.com> | 2018-05-01 16:10:38 +0000 |
---|---|---|
committer | Adrian Prantl <aprantl@apple.com> | 2018-05-01 16:10:38 +0000 |
commit | 4dfcc4a7882f5e6d6e66d3c535c01edb3c56053d (patch) | |
tree | c977b96be3795f8453239a86b93890394310a2cb /llvm/docs | |
parent | 661e6a02bdfe7c98dc108bfecca2c2a0cd1b5614 (diff) | |
download | bcm5719-llvm-4dfcc4a7882f5e6d6e66d3c535c01edb3c56053d.tar.gz bcm5719-llvm-4dfcc4a7882f5e6d6e66d3c535c01edb3c56053d.zip |
Remove @brief commands from doxygen comments, too.
This is a follow-up to r331272.
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
https://reviews.llvm.org/D46290
llvm-svn: 331275
Diffstat (limited to 'llvm/docs')
-rw-r--r-- | llvm/docs/GarbageCollection.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/llvm/docs/GarbageCollection.rst b/llvm/docs/GarbageCollection.rst index f7a987f4960..e4f5802f887 100644 --- a/llvm/docs/GarbageCollection.rst +++ b/llvm/docs/GarbageCollection.rst @@ -433,7 +433,7 @@ data structure, but there are only 20 lines of meaningful code.) .. code-block:: c++ - /// @brief The map for a single function's stack frame. One of these is + /// The map for a single function's stack frame. One of these is /// compiled as constant data into the executable for each function. /// /// Storage of metadata values is elided if the %metadata parameter to @@ -444,7 +444,7 @@ data structure, but there are only 20 lines of meaningful code.) const void *Meta[0]; //< Metadata for each root. }; - /// @brief A link in the dynamic shadow stack. One of these is embedded in + /// A link in the dynamic shadow stack. One of these is embedded in /// the stack frame of each function on the call stack. struct StackEntry { StackEntry *Next; //< Link to next stack entry (the caller's). @@ -452,13 +452,13 @@ data structure, but there are only 20 lines of meaningful code.) void *Roots[0]; //< Stack roots (in-place array). }; - /// @brief The head of the singly-linked list of StackEntries. Functions push + /// The head of the singly-linked list of StackEntries. Functions push /// and pop onto this in their prologue and epilogue. /// /// Since there is only a global list, this technique is not threadsafe. StackEntry *llvm_gc_root_chain; - /// @brief Calls Visitor(root, meta) for each GC root on the stack. + /// Calls Visitor(root, meta) for each GC root on the stack. /// root and meta are exactly the values passed to /// @llvm.gcroot. /// |