r175391 - Documentation: use \brief and don't duplicate the name of the declared entity

[James Dennett]

Author: jdennett
Date: Sun Feb 17 02:24:19 2013
New Revision: 175391

URL: http://llvm.org/viewvc/llvm-project?rev=175391&view=rev
Log:
Documentation: use \brief and don't duplicate the name of the declared entity
at the start of the doc comment.

Modified:
    cfe/trunk/include/clang/Basic/DiagnosticOptions.h

Modified: cfe/trunk/include/clang/Basic/DiagnosticOptions.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Basic/DiagnosticOptions.h?rev=175391&r1=175390&r2=175391&view=diff
==============================================================================
--- cfe/trunk/include/clang/Basic/DiagnosticOptions.h (original)
+++ cfe/trunk/include/clang/Basic/DiagnosticOptions.h Sun Feb 17 02:24:19 2013
@@ -24,8 +24,7 @@ enum OverloadsShown {
   Ovl_Best  ///< Show just the "best" overload candidates.
 };
 
-/// DiagnosticOptions - Options for controlling the compiler diagnostics
-/// engine.
+/// \brief Options for controlling the compiler diagnostics engine.
 class DiagnosticOptions : public RefCountedBase<DiagnosticOptions>{
 public:
   enum TextDiagnosticFormat { Clang, Msvc, Vi };
@@ -49,10 +48,10 @@ protected:
 #include "clang/Basic/DiagnosticOptions.def"
 
 public:
-  /// The file to log diagnostic output to.
+  /// \brief The file to log diagnostic output to.
   std::string DiagnosticLogFile;
   
-  /// The file to serialize diagnostics to (non-appending).
+  /// \brief The file to serialize diagnostics to (non-appending).
   std::string DiagnosticSerializationFile;
 
   /// The list of -W... options used to alter the diagnostic mappings, with the