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/tools | |
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/tools')
-rw-r--r-- | lldb/tools/debugserver/source/JSONGenerator.h | 2 | ||||
-rw-r--r-- | lldb/tools/intel-features/intel-pt/Decoder.h | 8 | ||||
-rw-r--r-- | lldb/tools/intel-features/intel-pt/PTDecoder.h | 14 |
3 files changed, 12 insertions, 12 deletions
diff --git a/lldb/tools/debugserver/source/JSONGenerator.h b/lldb/tools/debugserver/source/JSONGenerator.h index a85dcb6e860..7af6ae60c5f 100644 --- a/lldb/tools/debugserver/source/JSONGenerator.h +++ b/lldb/tools/debugserver/source/JSONGenerator.h @@ -21,7 +21,7 @@ //---------------------------------------------------------------------- /// @class JSONGenerator JSONGenerator.h -/// @brief A class which can construct structured data for the sole purpose +/// A class which can construct structured data for the sole purpose /// of printing it in JSON format. /// /// A stripped down version of lldb's StructuredData objects which are much diff --git a/lldb/tools/intel-features/intel-pt/Decoder.h b/lldb/tools/intel-features/intel-pt/Decoder.h index dc2794ac3bc..3762196058f 100644 --- a/lldb/tools/intel-features/intel-pt/Decoder.h +++ b/lldb/tools/intel-features/intel-pt/Decoder.h @@ -33,7 +33,7 @@ namespace ptdecoder_private { //---------------------------------------------------------------------- /// @class Instruction -/// @brief Represents an assembly instruction containing raw +/// Represents an assembly instruction containing raw /// instruction bytes, instruction address along with information /// regarding execution flow context and Intel(R) Processor Trace /// context. @@ -83,7 +83,7 @@ private: //--------------------------------------------------------------------------- /// @class InstructionList -/// @brief Represents a list of assembly instructions. Each instruction is of +/// Represents a list of assembly instructions. Each instruction is of /// type Instruction. //--------------------------------------------------------------------------- class InstructionList { @@ -113,7 +113,7 @@ private: //---------------------------------------------------------------------- /// @class TraceOptions -/// @brief Provides Intel(R) Processor Trace specific configuration options and +/// Provides Intel(R) Processor Trace specific configuration options and /// other information obtained by decoding and post-processing the trace /// data. Currently, this information comprises of the total number of /// assembly instructions executed for an inferior. @@ -147,7 +147,7 @@ private: //---------------------------------------------------------------------- /// @class Decoder -/// @brief This class makes use of Intel(R) Processor Trace hardware feature +/// This class makes use of Intel(R) Processor Trace hardware feature /// (implememted inside LLDB) to gather trace data for an inferior (being /// debugged with LLDB) to provide meaningful information out of it. /// diff --git a/lldb/tools/intel-features/intel-pt/PTDecoder.h b/lldb/tools/intel-features/intel-pt/PTDecoder.h index 9eb92745a86..8af8c8672b1 100644 --- a/lldb/tools/intel-features/intel-pt/PTDecoder.h +++ b/lldb/tools/intel-features/intel-pt/PTDecoder.h @@ -33,7 +33,7 @@ namespace ptdecoder { //---------------------------------------------------------------------- /// @class PTInstruction -/// @brief Represents an assembly instruction containing raw +/// Represents an assembly instruction containing raw /// instruction bytes, instruction address along with information /// regarding execution flow context and Intel(R) Processor Trace /// context. @@ -85,7 +85,7 @@ private: //--------------------------------------------------------------------------- /// @class PTInstructionList -/// @brief Represents a list of assembly instructions. Each instruction is of +/// Represents a list of assembly instructions. Each instruction is of /// type PTInstruction. //--------------------------------------------------------------------------- class PTInstructionList { @@ -114,7 +114,7 @@ private: //---------------------------------------------------------------------- /// @class PTTraceOptions -/// @brief Provides configuration options like trace type, trace buffer size, +/// Provides configuration options like trace type, trace buffer size, /// meta data buffer size along with other Intel(R) Processor Trace /// specific options. //---------------------------------------------------------------------- @@ -134,9 +134,9 @@ public: //------------------------------------------------------------------ /// Get Intel(R) Processor Trace specific configuration options (apart from - /// trace buffer size, meta data buffer size and TraceType) formatted as json - /// text i.e. {"Name":Value,"Name":Value} pairs, where "Value" is a 64-bit - /// unsigned integer in hex format. For "Name", please refer to + /// trace buffer size, meta data buffer size and TraceType) formatted as + /// json text i.e. {"Name":Value,"Name":Value} pairs, where "Value" is a + /// 64-bit unsigned integer in hex format. For "Name", please refer to /// SBProcess::StartTrace API description for setting SBTraceOptions. /// /// @return @@ -154,7 +154,7 @@ private: //---------------------------------------------------------------------- /// @class PTDecoder -/// @brief This class makes use of Intel(R) Processor Trace hardware feature +/// This class makes use of Intel(R) Processor Trace hardware feature /// (implememted inside LLDB) to gather trace data for an inferior (being /// debugged with LLDB) to provide meaningful information out of it. /// |