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

1 files changed, 38 insertions, 43 deletions

diff --git a/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionDeclMap.h b/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionDeclMap.h
index d163ad4f7e2..b6738793019 100644
--- a/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionDeclMap.h
+++ b/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionDeclMap.h
@@ -36,29 +36,28 @@ namespace lldb_private {
 
 //----------------------------------------------------------------------
 /// @class ClangExpressionDeclMap ClangExpressionDeclMap.h
-/// "lldb/Expression/ClangExpressionDeclMap.h"
-/// @brief Manages named entities that are defined in LLDB's debug information.
+/// "lldb/Expression/ClangExpressionDeclMap.h" Manages named entities that are
+/// defined in LLDB's debug information.
 ///
 /// The Clang parser uses the ClangASTSource as an interface to request named
 /// entities from outside an expression.  The ClangASTSource reports back,
-/// listing
-/// all possible objects corresponding to a particular name.  But it in turn
-/// relies on ClangExpressionDeclMap, which performs several important
+/// listing all possible objects corresponding to a particular name.  But it
+/// in turn relies on ClangExpressionDeclMap, which performs several important
 /// functions.
 ///
-/// First, it records what variables and functions were looked up and what Decls
-/// were returned for them.
+/// First, it records what variables and functions were looked up and what
+/// Decls were returned for them.
 ///
 /// Second, it constructs a struct on behalf of IRForTarget, recording which
-/// variables should be placed where and relaying this information back so that
-/// IRForTarget can generate context-independent code.
+/// variables should be placed where and relaying this information back so
+/// that IRForTarget can generate context-independent code.
 ///
 /// Third, it "materializes" this struct on behalf of the expression command,
 /// finding the current values of each variable and placing them into the
 /// struct so that it can be passed to the JITted version of the IR.
 ///
-/// Fourth and finally, it "dematerializes" the struct after the JITted code has
-/// has executed, placing the new values back where it found the old ones.
+/// Fourth and finally, it "dematerializes" the struct after the JITted code
+/// has has executed, placing the new values back where it found the old ones.
 //----------------------------------------------------------------------
 class ClangExpressionDeclMap : public ClangASTSource {
 public:
@@ -169,8 +168,8 @@ public:
                         lldb::offset_t alignment);
 
   //------------------------------------------------------------------
-  /// [Used by IRForTarget] Finalize the struct, laying out the position
-  /// of each object in it.
+  /// [Used by IRForTarget] Finalize the struct, laying out the position of
+  /// each object in it.
   ///
   /// @return
   ///     True on success; false otherwise.
@@ -178,8 +177,8 @@ public:
   bool DoStructLayout();
 
   //------------------------------------------------------------------
-  /// [Used by IRForTarget] Get general information about the laid-out
-  /// struct after DoStructLayout() has been called.
+  /// [Used by IRForTarget] Get general information about the laid-out struct
+  /// after DoStructLayout() has been called.
   ///
   /// @param[out] num_elements
   ///     The number of elements in the struct.
@@ -197,8 +196,8 @@ public:
                      lldb::offset_t &alignment);
 
   //------------------------------------------------------------------
-  /// [Used by IRForTarget] Get specific information about one field
-  /// of the laid-out struct after DoStructLayout() has been called.
+  /// [Used by IRForTarget] Get specific information about one field of the
+  /// laid-out struct after DoStructLayout() has been called.
   ///
   /// @param[out] decl
   ///     The parsed Decl for the field, as generated by ClangASTSource
@@ -232,8 +231,7 @@ public:
                         uint32_t index);
 
   //------------------------------------------------------------------
-  /// [Used by IRForTarget] Get information about a function given its
-  /// Decl.
+  /// [Used by IRForTarget] Get information about a function given its Decl.
   ///
   /// @param[in] decl
   ///     The parsed Decl for the Function, as generated by ClangASTSource
@@ -248,8 +246,8 @@ public:
   bool GetFunctionInfo(const clang::NamedDecl *decl, uint64_t &ptr);
 
   //------------------------------------------------------------------
-  /// [Used by IRForTarget] Get the address of a symbol given nothing
-  /// but its name.
+  /// [Used by IRForTarget] Get the address of a symbol given nothing but its
+  /// name.
   ///
   /// @param[in] target
   ///     The target to find the symbol in.  If not provided,
@@ -303,8 +301,8 @@ public:
   TargetInfo GetTargetInfo();
 
   //------------------------------------------------------------------
-  /// [Used by ClangASTSource] Find all entities matching a given name,
-  /// using a NameSearchContext to make Decls for them.
+  /// [Used by ClangASTSource] Find all entities matching a given name, using
+  /// a NameSearchContext to make Decls for them.
   ///
   /// @param[in] context
   ///     The NameSearchContext that can construct Decls for this name.
@@ -442,14 +440,13 @@ private:
   void DisableStructVars() { m_struct_vars.reset(); }
 
   //----------------------------------------------------------------------
-  /// Get this parser's ID for use in extracting parser- and JIT-specific
-  /// data from persistent variables.
+  /// Get this parser's ID for use in extracting parser- and JIT-specific data
+  /// from persistent variables.
   //----------------------------------------------------------------------
   uint64_t GetParserID() { return (uint64_t) this; }
 
   //------------------------------------------------------------------
-  /// Given a target, find a variable that matches the given name and
-  /// type.
+  /// Given a target, find a variable that matches the given name and type.
   ///
   /// @param[in] target
   ///     The target to use as a basis for finding the variable.
@@ -477,8 +474,8 @@ private:
                                       TypeFromUser *type = NULL);
 
   //------------------------------------------------------------------
-  /// Get the value of a variable in a given execution context and return
-  /// the associated Types if needed.
+  /// Get the value of a variable in a given execution context and return the
+  /// associated Types if needed.
   ///
   /// @param[in] var
   ///     The variable to evaluate.
@@ -524,8 +521,8 @@ private:
                       lldb::ValueObjectSP valobj, unsigned int current_id);
 
   //------------------------------------------------------------------
-  /// Use the NameSearchContext to generate a Decl for the given
-  /// persistent variable, and put it in the list of found entities.
+  /// Use the NameSearchContext to generate a Decl for the given persistent
+  /// variable, and put it in the list of found entities.
   ///
   /// @param[in] context
   ///     The NameSearchContext to use when constructing the Decl.
@@ -542,9 +539,8 @@ private:
                       unsigned int current_id);
 
   //------------------------------------------------------------------
-  /// Use the NameSearchContext to generate a Decl for the given LLDB
-  /// symbol (treated as a variable), and put it in the list of found
-  /// entities.
+  /// Use the NameSearchContext to generate a Decl for the given LLDB symbol
+  /// (treated as a variable), and put it in the list of found entities.
   ///
   /// @param[in] context
   ///     The NameSearchContext to use when constructing the Decl.
@@ -556,9 +552,9 @@ private:
                              unsigned int current_id);
 
   //------------------------------------------------------------------
-  /// Use the NameSearchContext to generate a Decl for the given
-  /// function.  (Functions are not placed in the Tuple list.)  Can
-  /// handle both fully typed functions and generic functions.
+  /// Use the NameSearchContext to generate a Decl for the given function.
+  /// (Functions are not placed in the Tuple list.)  Can handle both fully
+  /// typed functions and generic functions.
   ///
   /// @param[in] context
   ///     The NameSearchContext to use when constructing the Decl.
@@ -575,8 +571,7 @@ private:
                       unsigned int current_id);
 
   //------------------------------------------------------------------
-  /// Use the NameSearchContext to generate a Decl for the given
-  /// register.
+  /// Use the NameSearchContext to generate a Decl for the given register.
   ///
   /// @param[in] context
   ///     The NameSearchContext to use when constructing the Decl.
@@ -588,8 +583,8 @@ private:
                       unsigned int current_id);
 
   //------------------------------------------------------------------
-  /// Use the NameSearchContext to generate a Decl for the given
-  /// type.  (Types are not placed in the Tuple list.)
+  /// Use the NameSearchContext to generate a Decl for the given type.  (Types
+  /// are not placed in the Tuple list.)
   ///
   /// @param[in] context
   ///     The NameSearchContext to use when constructing the Decl.
@@ -601,8 +596,8 @@ private:
                   unsigned int current_id);
 
   //------------------------------------------------------------------
-  /// Generate a Decl for "*this" and add a member function declaration
-  /// to it for the expression, then report it.
+  /// Generate a Decl for "*this" and add a member function declaration to it
+  /// for the expression, then report it.
   ///
   /// @param[in] context
   ///     The NameSearchContext to use when constructing the Decl.