From ea1d56da6793facfb97e92bf05c640f7d3d43192 Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vz-swig@zeitlins.org>
Date: Sun, 13 Jul 2014 20:47:00 +0200
Subject: [PATCH] Use Sphinx-friendly formatting for overloaded functions
 documentation.

Sphinx doesn't allow sections inside the function documentation and gives tons
of SEVERE warnings for them, so while just emphasizing the "Overload" header
is not ideal, it is better than before because at least the string "Overload"
itself appears in the Sphinx-generated output.
---
 .../python/doxygen_basic_notranslate_runme.py          | 10 ++++------
 .../test-suite/python/doxygen_basic_translate_runme.py | 10 ++++------
 Source/DoxygenTranslator/src/PyDocConverter.cpp        | 10 +---------
 Source/DoxygenTranslator/src/PyDocConverter.h          |  5 -----
 4 files changed, 9 insertions(+), 26 deletions(-)

diff --git a/Examples/test-suite/python/doxygen_basic_notranslate_runme.py b/Examples/test-suite/python/doxygen_basic_notranslate_runme.py
index 54baf2e1e..bb2fae0f5 100644
--- a/Examples/test-suite/python/doxygen_basic_notranslate_runme.py
+++ b/Examples/test-suite/python/doxygen_basic_notranslate_runme.py
@@ -28,15 +28,13 @@ commentVerifier.check(doxygen_basic_notranslate.function2.__doc__,
 
 commentVerifier.check(doxygen_basic_notranslate.function3.__doc__,
     r"""
-    ----------------------------------------------------------------
-    Overload 1:
-    ----------------------------------------------------------------
+    *Overload 1:*
+
      A test for overloaded functions
      This is function \b one
      
-    ----------------------------------------------------------------
-    Overload 2:
-    ----------------------------------------------------------------
+    *Overload 2:*
+
      A test for overloaded functions
      This is function \b two
      
diff --git a/Examples/test-suite/python/doxygen_basic_translate_runme.py b/Examples/test-suite/python/doxygen_basic_translate_runme.py
index 303b81a45..0910ea8ea 100644
--- a/Examples/test-suite/python/doxygen_basic_translate_runme.py
+++ b/Examples/test-suite/python/doxygen_basic_translate_runme.py
@@ -26,15 +26,13 @@ commentVerifier.check(doxygen_basic_translate.function2.__doc__,
 )
 commentVerifier.check(doxygen_basic_translate.function3.__doc__,
     """
-    ----------------------------------------------------------------
-    Overload 1:
-    ----------------------------------------------------------------
+    *Overload 1:*
+
     A test for overloaded functions
     This is function **one**
 
-    ----------------------------------------------------------------
-    Overload 2:
-    ----------------------------------------------------------------
+    *Overload 2:*
+
     A test for overloaded functions
     This is function **two**
 
diff --git a/Source/DoxygenTranslator/src/PyDocConverter.cpp b/Source/DoxygenTranslator/src/PyDocConverter.cpp
index 05df48c0f..dec4fc0e5 100644
--- a/Source/DoxygenTranslator/src/PyDocConverter.cpp
+++ b/Source/DoxygenTranslator/src/PyDocConverter.cpp
@@ -692,10 +692,8 @@ String *PyDocConverter::makeDocumentation(Node *n)
       for (int realOverloadCount = 0;
           realOverloadCount < (int) allDocumentation.size();
           realOverloadCount++) {
-        concatDocString << generateDivider() << std::endl;
-        concatDocString << "Overload " << (realOverloadCount + 1) << ":"
+        concatDocString << "*Overload " << (realOverloadCount + 1) << ":*"
             << std::endl;
-        concatDocString << generateDivider();
         concatDocString << allDocumentation[realOverloadCount] << std::endl;
       }
       pyDocString = concatDocString.str();
@@ -744,9 +742,3 @@ String *PyDocConverter::makeDocumentation(Node *n)
 
   return NewString("");
 }
-
-std::string PyDocConverter::generateDivider()
-{
-  static string dividerString(DOC_STRING_LENGTH, '-');
-  return dividerString;
-}
diff --git a/Source/DoxygenTranslator/src/PyDocConverter.h b/Source/DoxygenTranslator/src/PyDocConverter.h
index 7f7dd53f9..a4214e49c 100644
--- a/Source/DoxygenTranslator/src/PyDocConverter.h
+++ b/Source/DoxygenTranslator/src/PyDocConverter.h
@@ -168,11 +168,6 @@ protected:
   void handleHtmlEntity(DoxygenEntity&, std::string& translatedComment, const std::string &arg);
 
 
-  /*
-   * Utility method to generate a diving line for a documentation string.
-   */
-  std::string generateDivider();
-
   /*
    * Simple helper function that calculates correct parameter type
    * of the node stored in 'currentNode'