Added a tiny program that adds stars (*) in the right column for all multiline Doxygen comments starting with /** or /*./configure The addition of these starts keeps inlining tools from re-indenting our carefully crafted documentation. It would be as easy to remove the stars after the indentation process. Or even better, carefully reformat the Doxygen comments after they have benn indented.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7465 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2010-04-07 16:46:02 +00:00 · 2010-04-07 16:46:02 +00:00 · 34736e17ac
commit 34736e17ac
parent 2d92942bfe
1 changed files with 102 additions and 0 deletions
--- a/misc/doxystar.cxx
+++ b/misc/doxystar.cxx
@ -0,0 +1,102 @@
+//
+// "$Id: doxystar.cxx 6615 2009-01-01 16:35:13Z matt $"
+//
+// Doxygen pre-formatting program for the Fast Light Tool Kit (FLTK).
+//
+// Copyright 2010 by Matthias Melcher.
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Library General Public License for more details.
+//
+// You should have received a copy of the GNU Library General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+// USA.
+//
+// Please report all bugs and problems on the following page:
+//
+//     http://www.fltk.org/str.php
+//
+
+#include <stdio.h>
+#include <string.h>
+
+char linebuf[1024];
+
+
+
+int main(int argc, char *argv) {
+  if (argc!=1) {
+    puts("Add stars (*) in front of multi-line doxygen comments");
+    puts("to protect comment indentation from code beautifiers.");
+    puts("usage: cat file | doxystar");
+    return 0;
+  }
+
+  int state = 0;
+  char *commentStart;
+  int i, commentCol;
+  for (;;) {
+    if (!fgets(linebuf, 1020, stdin)) break; // EOF or error
+    switch (state) {
+      case 0: // line start is source code
+        commentStart = strstr(linebuf, "/*"); 
+        if (commentStart) {
+          // check if this comment spans multiple lines
+          if (strstr(commentStart, "*/")==0) {
+            if ((commentStart[2]=='*' || commentStart[2]=='!') && commentStart[3]!='*') {
+              state = 2; // Doxygen multiline comment
+              commentCol = commentStart - linebuf;
+            } else {
+              state = 1; // regular multiline comment
+            }
+          } else { 
+            // single line comment, do nothing
+          }
+        }
+        fputs(linebuf, stdout);
+        break;
+      case 1: // line start is inside a regular multiline comment
+        if (strstr(linebuf, "*/")) {
+          state = 0;
+        } else {
+          // still inside comment
+        }
+        fputs(linebuf, stdout);
+        break;
+      case 2: // line start is inside a doxygen  multiline comment
+        for (i=0; i<commentCol; i++) fputc(' ', stdout);
+        fputs(" *", stdout); 
+        if (strstr(linebuf, "*/")) {
+          state = 0;
+        } else {
+          // still inside comment
+        }
+        for (i=0; i<commentCol+1; i++) 
+          if (linebuf[i]!=' ')
+            break;
+        if (linebuf[i]=='*') {
+          if (linebuf[i+1]==' ') {
+            i+=2;
+          } else {
+            i+=1;
+          }
+        }
+        fputs(linebuf+i, stdout);
+        break;
+    }
+  }
+
+  return 0;
+}
+
+//
+// End of "$Id: doxystar.cxx 6615 2009-01-01 16:35:13Z matt $".
+//