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

Doxygen comments take precedence over the autodoc feature.

Browse source 
If a "docstring" feature is present it will still override a Doxygen comment.
If the "autodoc" feature is also present, the combined "autodoc" and "docstring"
will override the Doxygen comment. If no "docstring" is present then the
"autodoc" feature will not be generated when there is a Doxygen comment.

This way the "autodoc" feature can be specified and used to provide documentation
for 'missing' Doxygen comments.

Closes #1635
This commit is contained in:
William S Fulton 2022-04-06 08:08:14 +01:00
commit b35ebc81a9
7 changed files with 175 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

44
Examples/test-suite/python/doxygen_autodoc_docstring_runme.py Normal file
View file

@ -0,0 +1,44 @@
from doxygen_autodoc_docstring import *
import inspect
import string
import os
import sys
import comment_verifier
# documentation from autogenerated 'feature:autodoc'
comment_verifier.check(inspect.getdoc(ClassWithoutDoxygenComment),
"Proxy of C++ ClassWithoutDoxygenComment class.")
comment_verifier.check(inspect.getdoc(functionWithoutDoxygenComment),
"functionWithoutDoxygenComment(int number)")
# documentation from doxygen comments
comment_verifier.check(inspect.getdoc(ClassWithDoxygenComment),
"Class doxygen comment")
comment_verifier.check(inspect.getdoc(functionWithDoxygenComment),
"Function doxygen comment")
# documentation from 'feature:docstring'
comment_verifier.check(inspect.getdoc(ClassWithDocString),
"Class doc from docstring")
comment_verifier.check(inspect.getdoc(functionWithDocString),
"functionWithDocString(int number)\n"
"Function doc from docstring")
# documentation from 'feature:docstring' + autodoc (overriding doxycomment)
comment_verifier.check(inspect.getdoc(ClassWithDocStringAndDoxygenComment),
"Class doc from docstring overriding doxycomment")
comment_verifier.check(inspect.getdoc(functionWithDocStringAndDoxygenComment),
"functionWithDocStringAndDoxygenComment(int number)\n"
"Function doc from docstring overriding doxycomment")
# documentation from 'feature:docstring' (overriding doxycomment)
comment_verifier.check(inspect.getdoc(ClassWithDocStringAndDoxygenCommentNoAutodoc),
"Class doc from docstring overriding doxycomment (no autodoc)")
comment_verifier.check(inspect.getdoc(functionWithDocStringAndDoxygenCommentNoAutodoc),
"Function doc from docstring overriding doxycomment (no autodoc)")
# documentation from doxygen comments (2) no autodoc feature present
comment_verifier.check(inspect.getdoc(ClassWithDoxygenComment2),
"Class doxygen comment 2")
comment_verifier.check(inspect.getdoc(functionWithDoxygenComment2),
"Function doxygen comment 2")