[cfe-commits] PATCH: Fix another bunch of Doxygen-formatting gremlins

[Dmitri Gribenko]

Hi James,

Thank you for this work!  I have two comments.

On Tue, Jun 12, 2012 at 4:57 PM, James Dennett <jdennett at google.com> wrote:
> This reduces the number of warnings generated by Doxygen by about 100
> (roughly 10%).

Index: include/clang/Frontend/HeaderSearchOptions.h
===================================================================
--- include/clang/Frontend/HeaderSearchOptions.h	(revision 158335)
+++ include/clang/Frontend/HeaderSearchOptions.h	(working copy)
@@ -17,12 +17,12 @@ namespace clang {

 namespace frontend {
   /// IncludeDirGroup - Identifiers the group a include entry belongs to, which
-  /// represents its relative positive in the search list.  A #include of a ""
+  /// represents its relative positive in the search list.  A \#include of a ""
   /// path starts at the -iquote group, then searches the Angled group, then
   /// searches the system group, etc.
   enum IncludeDirGroup {
-    Quoted = 0,     ///< '#include ""' paths, added by'gcc -iquote'.
-    Angled,         ///< Paths for '#include <>' added by '-I'.
+    Quoted = 0,     ///< '\#include ""' paths, added by'gcc -iquote'.
+    Angled,         ///< Paths for '\#include <>' added by '-I'.
     IndexHeaderMap, ///< Like Angled, but marks header maps used when
                        ///  building frameworks.
     System,         ///< Like Angled, but marks system directories.

Missing space in "by'gcc".

Index: include/clang/Basic/SourceManagerInternals.h
===================================================================
--- include/clang/Basic/SourceManagerInternals.h	(revision 158335)
+++ include/clang/Basic/SourceManagerInternals.h	(working copy)
@@ -30,11 +30,11 @@ struct LineEntry {
   /// FileOffset - The offset in this file that the line entry occurs at.
   unsigned FileOffset;

-  /// LineNo - The presumed line number of this line entry: #line 4.
+  /// LineNo - The presumed line number of this line entry: \#line 4.
   unsigned LineNo;

Doxygen understands which comment is attached to which declaration.
Programmer sees that too.  So there is no need to duplicate the
identifier within comments.  I know that this duplication is all over
the clang codebase, but since you are touching those lines anyway...

Dmitri

-- 
main(i,j){for(i=2;;i++){for(j=2;j<i;j++){if(!(i%j)){j=0;break;}}if
(j){printf("%d\n",i);}}} /*Dmitri Gribenko <gribozavr at gmail.com>*/