STYLE: improve formatting of doxygen filter output

bin/tools/doxyFilter.awk

@@ -29,70 +29,71 @@
 #
 #     Assumes comment strings are formatted as follows
 #         //- General description
-#         //  Detailed information
-#         //  and even more information
-#     or
-#         //- General description
-#         //- that spans several
-#         //- lines
-#         //  Detailed information
-#         //  and even more information
-#
+#         //- with a continuation of general description
+#         //  Detailed description
+#         //  with more particulars
 #     This should be re-formatted as the following
-#         /*! \brief General description
-#          that spans several
-#          lines
+#         /*!
+#          * \brief General description
+#          * with a continuation of general description
+#          *
+#          * Detailed description
+#          * with more particulars
 #          */
-#         /*! Detailed information
-#         and even more information
-#         */
-#
-#     The intermediate "/*! ... */" block is left-justified to handle
-#     possible verbatim text
-#
 #------------------------------------------------------------------------------
 
-# States: 0=normal, 1=brief, 2=details
+# state:  0=normal, 1=brief, 2=details
+# indent: whitespace content prior to the opening "//-"
 BEGIN {
     state = 0
+    indent = ""
 }
 
-/^ *\/\/-/ {
+/^\s*\/\/-/ {
     if (state == 0)
     {
         # Changed from normal to brief (start of comment block)
-        printf "/*! \\brief"
+        ## indent = substr($0, 1, index($0, "/")-1)
+        indent = $0
+        sub(/\S.*/, "", indent)
+        printf indent "/*!\n"
+        printf indent " * \\brief "
+        sub(/^\s*\/\/-\s*/, "")
         state = 1
     }
-
-    if (state == 1)
+    else
     {
-        # Within brief: strip leading
-        if (!sub(/^ *\/\/-  /, ""))
-        {
-            sub(/^ *\/\/-/, "")
-        }
+        # Within brief: replace leading space with proper indent amount
+        printf indent
+        sub(/^\s*\/\/-\s*/, " * ")
     }
 
     print
     next
 }
 
-/^ *\/\// {
+
+/^\s*\/\// {
     if (state == 1)
     {
-        # Change from brief to details
-        printf "*/\n"
-        printf "/*! "
+        # Change from brief to details. Extra line to start new paragraph.
+        printf indent " *\n"
         state = 2
     }
 
     if (state == 2)
     {
-        # Within details: strip leading
-        if (!sub(/^ *\/\/  /, ""))
+        # Within details
+        printf indent
+
+        # '//' with 4 spaces or more - assume indent is intentional
+        if (match($0, /^\s*\/\/(    )+/))
         {
-            sub(/^ *\/\//, "")
+            sub(/^\s*\/\/\s/, " *")
+        }
+        else
+        {
+            sub(/^\s*\/\/\s*/, " * ")
         }
     }
 
@@ -100,13 +101,14 @@ BEGIN {
     next
 }
 
+
 {
     # End comment filtering
     if (state)
     {
-        printf "*/\n"
-    }
+        printf indent " */\n"
         state = 0
+    }
     print
     next
 }

bin/tools/doxyFilter.sed

@@ -14,13 +14,6 @@ s?^License.*?\*\/\
 \/\*! \\file %realFilePath%\
 <b>Original source file</b> <a href="%filePath%">%fileName%</a>\
 \
-\
-\
-\
-\
-\
-\
-\
 ?
 /^    /d
 }
@@ -112,7 +105,8 @@ s/^    /\\typedef /
 # the first paragraph will be 'brief' and the others 'detail'
 /^Description *$/,/^[^ ]/{
 /^Description/c\
-<a class="anchor" name="Description"></a> \\brief
+<a class="anchor" name="Description"></a>\
+\\brief
 s/^    //
 }
 
@@ -145,7 +139,8 @@ s/^    //
 
 /^SourceFiles *$/,/^$/{
 s?SourceFiles?\\par Source files\
-<ul><li><a href="%filePath%">%fileName%</a></li>?
+<ul>\
+  <li><a href="%filePath%">%fileName%</a></li> ?
 s? *\([a-zA-Z0-9]*\.[a-zA-Z]*\)?  <li><a href="%dirName%/\1">\1</a></li>?
 s?^$?</ul>?
 }
@@ -164,7 +159,7 @@ s/.*\*\//\*\//
 # Convert \heading in source files to bold font and add some space
 s#\\heading \(.*\)#<br><b>\1</b>#g
 
-# add a linebreak
+# Add a linebreak
 s#\\linebreak#<br>#g
 
 }