if feature doxygen:notranslate is used, comments are now properly decorated with '*'s.

git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13730 626c5289-ae23-0410-ae9c-e8d60b6d4f22

3 files changed, 87 insertions, 17 deletions

diff --git a/Examples/test-suite/doxygen_misc_constructs.i b/Examples/test-suite/doxygen_misc_constructs.i
index bbec4c3ed..80627559b 100644
--- a/Examples/test-suite/doxygen_misc_constructs.i
+++ b/Examples/test-suite/doxygen_misc_constructs.i
@@ -8,20 +8,19 @@
     // Tag '@endink' must be recognized even if it is not

     // followed by whitespace.

 

-    /** 

-     * Tag endlink must be recognized also when followed by nonspace charater.

+    /** Tag endlink must be recognized also when followed by nonspace charater.

      *

-     * @link Connection::getId() @endlink<br>

-     */

+     * @link Connection::getId() @endlink<br> */

+     

     char g_counter;

 

 

     /** 

-     * Tag endlink must be recognized also when it is the last token

-     * in the commment.

-     *

-     * @link Connection::getId() @endlink<br>

-     * @link debugIdeTraceProfilerCoverageSample.py Python example. @endlink

+      Tag endlink must be recognized also when it is the last token

+      in the commment.

+

+      @link Connection::getId() @endlink<br>

+      @link debugIdeTraceProfilerCoverageSample.py Python example. @endlink

      */

     int g_zipCode;

 

@@ -95,7 +94,7 @@
     class ClassWithNestedEnum {

     public:

         /**

-         * Enum description.

+         * Enum description.b

          */

         typedef enum {ONE,  ///< desc of one

                       TWO,  ///< desc of two

diff --git a/Source/DoxygenTranslator/src/JavaDocConverter.cpp b/Source/DoxygenTranslator/src/JavaDocConverter.cpp
index 2c2aa8aa0..2144ffb9e 100644
--- a/Source/DoxygenTranslator/src/JavaDocConverter.cpp
+++ b/Source/DoxygenTranslator/src/JavaDocConverter.cpp
@@ -116,7 +116,7 @@ void JavaDocConverter::fillStaticTables() {
 
 
 JavaDocConverter::JavaDocConverter(bool debugTranslator, bool debugParser)
-: DoxygenTranslator(debugTranslator, debugParser) {
+: DoxygenTranslator(true, true) {
   fillStaticTables();
 }
 
@@ -528,6 +528,75 @@ int JavaDocConverter::shiftEndlinesUpTree(DoxygenEntity &root, int level)
 }
 
 
+/**
+ * This makes sure that all comment lines contain '*'. It is not mandatory in doxygen,
+ * but highly recommended for Javadoc. '*' in empty lines are indented according
+ * to indentation of the first line. Indentation of non-empty lines is not
+ * changed - garbage in garbage out.
+ */
+std::string JavaDocConverter::indentAndInsertAsterisks(const string &doc) {
+
+  size_t idx = doc.find('\n');
+  size_t indent = 0;
+  // Detect indentation.
+  //   The first line in comment is the one after '/**', which may be
+  //   spaces and '\n' or the text. In any case it is not suitable to detect
+  //   indentation, so we have to skip the first '\n'.
+  if (idx != string::npos) {
+    size_t nonspaceIdx = doc.find_first_not_of(' ', idx + 1);
+    if (nonspaceIdx != string::npos) {
+      indent = nonspaceIdx - idx;
+    }
+  }
+
+  // Create the first line of Javadoc comment.
+  string indentStr(indent - 1, ' ');
+  string translatedStr = indentStr + "/**";
+  if (indent > 1) {
+    // remove the first space, so that '*' will be aligned
+    translatedStr = translatedStr.substr(1);
+  }
+
+  translatedStr += doc;
+
+  // insert '*' before each comment line, if it does not have it
+  idx = translatedStr.find('\n');
+
+  while (idx != string::npos) {
+
+    size_t nonspaceIdx = translatedStr.find_first_not_of(' ', idx + 1);
+    if (nonspaceIdx != string::npos  &&  translatedStr[nonspaceIdx] != '*') {
+
+      // line without '*' found - is it empty?
+      if (translatedStr[nonspaceIdx] != '\n') {
+        // add '* ' to each line without it
+        translatedStr = translatedStr.substr(0, nonspaceIdx) + "* " +
+                translatedStr.substr(nonspaceIdx);
+      } else {
+        // we found empty line, replace it with indented '*'
+        translatedStr = translatedStr.substr(0, idx + 1) + indentStr +
+                "* " + translatedStr.substr(nonspaceIdx);
+      }
+    }
+    idx = translatedStr.find('\n', nonspaceIdx);
+  }
+
+  // Add the last comment line properly indented
+  size_t nonspaceEndIdx = translatedStr.find_last_not_of(' ');
+  if (nonspaceEndIdx != string::npos) {
+    if (translatedStr[nonspaceEndIdx] != '\n') {
+      translatedStr += '\n';
+    } else {
+      // remove trailing spaces
+      translatedStr = translatedStr.substr(0, nonspaceEndIdx + 1);
+    }
+  }
+  translatedStr += indentStr + "*/\n";
+
+  return translatedStr;
+}
+
+
 String *JavaDocConverter::makeDocumentation(Node *node) {
 
   String *documentation = getDoxygenComment(node);
@@ -537,12 +606,13 @@ String *JavaDocConverter::makeDocumentation(Node *node) {
   }
 
   if (GetFlag(node, "feature:doxygen:notranslate")) {
-    String *comment = NewString("/**\n");
-    Append(comment, documentation);
-    // reformat the comment
-    Replaceall(comment, "\n *", "\n");
-    Replaceall(comment, "\n", "\n * ");
-    Append(comment, "\n */\n");
+
+    string doc = Char(documentation);
+
+    string translatedStr = indentAndInsertAsterisks(doc);
+
+    String *comment = NewString(translatedStr.c_str());
+    // Append(comment, documentation); Replaceall(comment, "\n", "\n * ");
     return comment;
   }
 
diff --git a/Source/DoxygenTranslator/src/JavaDocConverter.h b/Source/DoxygenTranslator/src/JavaDocConverter.h
index 1fab5e63b..9715593c6 100644
--- a/Source/DoxygenTranslator/src/JavaDocConverter.h
+++ b/Source/DoxygenTranslator/src/JavaDocConverter.h
@@ -127,6 +127,7 @@ private:
   void fillStaticTables();
 
   bool paramExists(std::string param);
+  std::string indentAndInsertAsterisks(const std::string &doc);
 };
 
 #endif