diff options
| author | Adrian Prantl <aprantl@apple.com> | 2018-05-02 16:55:16 +0000 |
|---|---|---|
| committer | Adrian Prantl <aprantl@apple.com> | 2018-05-02 16:55:16 +0000 |
| commit | d8f460e864307f6cf71d9dec63fe3a99ddb4f2b5 (patch) | |
| tree | c4e362893448c65bf4d612209af36cf19cf184fc /lldb/source/Plugins/DynamicLoader | |
| parent | 1ab34573197db6efd1eb07b95b836e46f1f88478 (diff) | |
| download | bcm5719-llvm-d8f460e864307f6cf71d9dec63fe3a99ddb4f2b5.tar.gz bcm5719-llvm-d8f460e864307f6cf71d9dec63fe3a99ddb4f2b5.zip | |
Enable AUTOBRIEF in doxygen configuration.
This brings the LLDB configuration closer to LLVM's and removes visual
clutter in the source code by removing the @brief commands from
comments.
This patch also reflows the paragraphs in all doxygen comments.
See also https://reviews.llvm.org/D46290.
Differential Revision: https://reviews.llvm.org/D46321
llvm-svn: 331373
Diffstat (limited to 'lldb/source/Plugins/DynamicLoader')
3 files changed, 25 insertions, 22 deletions
diff --git a/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/HexagonDYLDRendezvous.h b/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/HexagonDYLDRendezvous.h index b68f89b9ce8..9e7129461f0 100644 --- a/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/HexagonDYLDRendezvous.h +++ b/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/HexagonDYLDRendezvous.h @@ -24,12 +24,12 @@ class Process; } /// @class HexagonDYLDRendezvous -/// @brief Interface to the runtime linker. +/// Interface to the runtime linker. /// /// A structure is present in a processes memory space which is updated by the -/// runtime liker each time a module is loaded or unloaded. This class provides -/// an interface to this structure and maintains a consistent snapshot of the -/// currently loaded modules. +/// runtime liker each time a module is loaded or unloaded. This class +/// provides an interface to this structure and maintains a consistent +/// snapshot of the currently loaded modules. class HexagonDYLDRendezvous { // This structure is used to hold the contents of the debug rendezvous @@ -124,7 +124,7 @@ public: void DumpToLog(lldb_private::Log *log) const; - /// @brief Constants describing the state of the rendezvous. + /// Constants describing the state of the rendezvous. /// /// @see GetState(). enum RendezvousState { @@ -133,8 +133,8 @@ public: eDelete, }; - /// @brief Structure representing the shared objects currently loaded into - /// the inferior process. + /// Structure representing the shared objects currently loaded into the + /// inferior process. /// /// This object is a rough analogue to the struct link_map object which /// actually lives in the inferiors memory. @@ -198,7 +198,8 @@ protected: /// List of SOEntry objects corresponding to the current link map state. SOEntryList m_soentries; - /// List of SOEntry's added to the link map since the last call to Resolve(). + /// List of SOEntry's added to the link map since the last call to + /// Resolve(). SOEntryList m_added_soentries; /// List of SOEntry's removed from the link map since the last call to diff --git a/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/AuxVector.h b/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/AuxVector.h index cf9da080835..3b06fe18f0c 100644 --- a/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/AuxVector.h +++ b/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/AuxVector.h @@ -22,12 +22,12 @@ class DataExtractor; } /// @class AuxVector -/// @brief Represents a processes auxiliary vector. +/// Represents a processes auxiliary vector. /// /// When a process is loaded on Linux a vector of values is placed onto the -/// stack communicating operating system specific information. On construction -/// this class locates and parses this information and provides a simple -/// read-only interface to the entries found. +/// stack communicating operating system specific information. On +/// construction this class locates and parses this information and provides a +/// simple read-only interface to the entries found. class AuxVector { public: @@ -41,8 +41,9 @@ public: }; /// Constants describing the type of entry. - /// On Linux, running "LD_SHOW_AUXV=1 ./executable" will spew AUX information. - /// Added AUXV prefix to avoid potential conflicts with system-defined macros + /// On Linux, running "LD_SHOW_AUXV=1 ./executable" will spew AUX + /// information. Added AUXV prefix to avoid potential conflicts with system- + /// defined macros enum EntryType { AUXV_AT_NULL = 0, ///< End of auxv. AUXV_AT_IGNORE = 1, ///< Ignore entry. diff --git a/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DYLDRendezvous.h b/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DYLDRendezvous.h index 295ae55e1b8..a7071801f56 100644 --- a/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DYLDRendezvous.h +++ b/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DYLDRendezvous.h @@ -29,12 +29,12 @@ class Process; } /// @class DYLDRendezvous -/// @brief Interface to the runtime linker. +/// Interface to the runtime linker. /// /// A structure is present in a processes memory space which is updated by the -/// runtime liker each time a module is loaded or unloaded. This class provides -/// an interface to this structure and maintains a consistent snapshot of the -/// currently loaded modules. +/// runtime liker each time a module is loaded or unloaded. This class +/// provides an interface to this structure and maintains a consistent +/// snapshot of the currently loaded modules. class DYLDRendezvous { // This structure is used to hold the contents of the debug rendezvous @@ -119,13 +119,13 @@ public: void DumpToLog(lldb_private::Log *log) const; - /// @brief Constants describing the state of the rendezvous. + /// Constants describing the state of the rendezvous. /// /// @see GetState(). enum RendezvousState { eConsistent, eAdd, eDelete }; - /// @brief Structure representing the shared objects currently loaded into - /// the inferior process. + /// Structure representing the shared objects currently loaded into the + /// inferior process. /// /// This object is a rough analogue to the struct link_map object which /// actually lives in the inferiors memory. @@ -194,7 +194,8 @@ protected: /// List of SOEntry objects corresponding to the current link map state. SOEntryList m_soentries; - /// List of SOEntry's added to the link map since the last call to Resolve(). + /// List of SOEntry's added to the link map since the last call to + /// Resolve(). SOEntryList m_added_soentries; /// List of SOEntry's removed from the link map since the last call to |

