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

Added doxygen switches doc

Browse source 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13185 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Dmitry Kabak 2012-06-18 19:31:35 +00:00
commit 4141c9fd87
1 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/Manual/Doxygen.html
View file

@ -114,7 +114,16 @@ Just remember, if SWIG shows syntax error parsing the file because of your comme
<p>
NOT YET ADDED (current development branch has this feature automatically enabled).
There are switches like '-doxygen' and '-nodoxygen' in every module that supports converting
documentation comments. The first one is default, so that swig by default produces correct
proxy files with comments. Some comments in some target languages can be manually overriden by specific
swig's features, like <i>feature:docstring</i> or <i>feature:autodoc</i>, in this cases doxygen comments
have lowest priority.
</p>
<p>
Switching off may be needed if swig cannot correctly parse your comments, for example showing <i>Error:
Syntax error in input(1).</i> message. Then it will just strip out every comment out of the code and
continue happily.
</p>
<H3><a name="Doxygen_additional_options"></a>35.2.2 Additional Commandline Options</H3>