jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Use Sphinx-friendly formatting for overloaded functions documentation.

Browse source 
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.
This commit is contained in:
Vadim Zeitlin 2014-07-13 20:47:00 +02:00
commit ea1d56da67
4 changed files with 9 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Examples/test-suite/python/doxygen_basic_notranslate_runme.py
View file

@ -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

10
Examples/test-suite/python/doxygen_basic_translate_runme.py
View file

@ -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**