From 4141c9fd8712797401da42be00ad8e7c5bf498c0 Mon Sep 17 00:00:00 2001 From: Dmitry Kabak Date: Mon, 18 Jun 2012 19:31:35 +0000 Subject: [PATCH] Added doxygen switches doc git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13185 626c5289-ae23-0410-ae9c-e8d60b6d4f22 --- Doc/Manual/Doxygen.html | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/Doc/Manual/Doxygen.html b/Doc/Manual/Doxygen.html index 989fb0dc4..d0e837756 100644 --- a/Doc/Manual/Doxygen.html +++ b/Doc/Manual/Doxygen.html @@ -114,7 +114,16 @@ Just remember, if SWIG shows syntax error parsing the file because of your comme

-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 feature:docstring or feature:autodoc, in this cases doxygen comments +have lowest priority. +

+

+Switching off may be needed if swig cannot correctly parse your comments, for example showing Error: +Syntax error in input(1). message. Then it will just strip out every comment out of the code and +continue happily.

35.2.2 Additional Commandline Options