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

New fixes for the project plan

Browse source 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13273 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Dmitry Kabak 2012-07-09 11:08:56 +00:00
commit 32166f96f4
1 changed files with 20 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

33
Doc/Devel/plan-gsoc-2012.txt
View file

@ -23,6 +23,10 @@ There will also be a possiblity to add untranslated comments to Java
and Python code (## comments, see Doxygen manual), if the user will and Python code (## comments, see Doxygen manual), if the user will
prefer to use Doxygen on the generated code. prefer to use Doxygen on the generated code.
Note:
time format below is HH:MM. '--Done' tick means that the item is
implemented, commited and working.
Abbreviations: Abbreviations:
JD - JavaDoc JD - JavaDoc
PD - PyDoc PD - PyDoc
@ -41,6 +45,7 @@ Functionality
1. Only JavaDoc (/** */) and Qt (/*! */) styles of comment blocks 1. Only JavaDoc (/** */) and Qt (/*! */) styles of comment blocks
will be supported by SWIG translator. will be supported by SWIG translator.
--Done
2. The following doc after members will be supported: 2. The following doc after members will be supported:
@ -50,11 +55,14 @@ Functionality
int var; //!< Brief description after the member int var; //!< Brief description after the member
int var; ///< Brief description after the member int var; ///< Brief description after the member
--Done
3. Only comments before or after declaration/definition will be 3. Only comments before or after declaration/definition will be
supported. Comments with structural commands will be ignored supported. Comments with structural commands will be ignored
(warning will be written). (What about writing them to (warning will be written). (What about writing them to
'package.info.java' for JD?) 'package.info.java' for JD?)
--Done
Tags Tags
@ -63,10 +71,8 @@ Functionality
This section contains all doxygen tags taken from This section contains all doxygen tags taken from
http://www.stack.nl/~dimitri/doxygen/commands.html. If a tag is http://www.stack.nl/~dimitri/doxygen/commands.html. If a tag is
marked as 'ignored', then the tag is ignored, but the text is copied marked as 'ignored', then the tag is ignored, but the text is copied
to the destination documentation. to the destination documentation. 'Not implemented' means that the
Not all of the tags are currently implemented. The status of tag with it's contents is stripped out of the output.
implementation and time estimation for every tag may be seen in
plan-gsoc-2012-timings.txt
Doxygen tags: Doxygen tags:
@ -97,8 +103,8 @@ Functionality
performing copy performing copy
\copyright - replaced with text 'Copyright' in PD and PD \copyright - replaced with text 'Copyright' in PD and PD
\date - ignored \date - ignored
\def \def - ignored (structural command)
\defgroup \defgroup - not supported
\deprecated - translated to @deprecated in JD, 'Deprecated:' in PD \deprecated - translated to @deprecated in JD, 'Deprecated:' in PD
\details - ignored \details - ignored
\dir - not supported \dir - not supported
@ -128,13 +134,14 @@ Functionality
\example - translated to 'Example:' in JD and PD \example - translated to 'Example:' in JD and PD
\exception - equivalent to throws, but translates to @exception in JD \exception - equivalent to throws, but translates to @exception in JD
\extends - not supported \extends - not supported
\f$ \f$ - not supported. Later swig may call LATeX to produce bitmaps with formulas
\f[ to include in JD and PD
\f] \f[ - see note for \f$
\f{ \f] - see note for \f$
\f} \f{ - see note for \f$
\file \f} - see note for \f$
\fn \file - ignored (structural command)
\fn - ignored (structural command)
\headerfile - not supported \headerfile - not supported
\hideinitializer - not supported \hideinitializer - not supported
\htmlinclude - not supported \htmlinclude - not supported