From: James Dennett <jdennett@google.com>
Date: Sun, 17 Feb 2013 08:24:19 +0000 (+0000)
Subject: Documentation: use \brief and don't duplicate the name of the declared entity
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=6c31f7c56f54cc1c52475675335729290663535c;p=clang

Documentation: use \brief and don't duplicate the name of the declared entity
at the start of the doc comment.


git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@175391 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/include/clang/Basic/DiagnosticOptions.h b/include/clang/Basic/DiagnosticOptions.h
index 1a68d95765..2fba3844a0 100644
--- a/include/clang/Basic/DiagnosticOptions.h
+++ b/include/clang/Basic/DiagnosticOptions.h
@@ -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