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

Extended project plan, now it is also the description of how are the doxygen tags translated

Browse source 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13269 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Dmitry Kabak 2012-07-09 10:11:29 +00:00
commit 0e2f37bc54
1 changed files with 114 additions and 104 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -64,19 +64,22 @@ Functionality
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 all of the tags are currently implemented. The status of
implementation and time estimation for every tag may be seen in
plan-gsoc-2012-timings.txt
Supported: Doxygen tags:
\a - translated to <i></i> in JD, surrounded with _ in PD \a - translated to <i></i> in JD, surrounded with _ in PD
\addindex - ignored \addindex - ignored
\addtogroup - ignored \addtogroup - ignored
\anchor - ignored, not supported by JD and PD \anchor - ignored, not supported by JD and PD
\arg - translated to @param in JD, special formatting in PD \arg - translated to @param in JD, special formatting in PD
\attention - ignored, content printed out \attention - ignored
\authors, \author - translated to @author in JD, 'Author:' in PD \authors, \author - translated to @author in JD, 'Author:' in PD
\b - <b></b> in JD, surrounded with __ in PD \b - <b></b> in JD, surrounded with __ in PD
\brief - ignored, content printed out \brief - ignored
\bug - ignored, content printed out \bug - ignored
\c - translated to <code></code> in JD, ignored in PD \c - translated to <code></code> in JD, ignored in PD
\callgraph - ignored, not supported by JD and PD \callgraph - ignored, not supported by JD and PD
\callergraph - ignored, not supported by JD and PD \callergraph - ignored, not supported by JD and PD
@ -93,132 +96,139 @@ Functionality
\copydoc - ignored. Later SWIG may support this command by \copydoc - ignored. Later SWIG may support this command by
performing copy performing copy
\copyright - replaced with text 'Copyright' in PD and PD \copyright - replaced with text 'Copyright' in PD and PD
\date - ignored, content printed out \date - ignored
\def \def
\defgroup \defgroup
\deprecated - translated to @deprecated in JD, 'Deprecated:' in PD \deprecated - translated to @deprecated in JD, 'Deprecated:' in PD
\details - ignored, content printed out \details - ignored
\dir - not supported \dir - not supported
\dontinclude - not supported \dontinclude - not supported
\dot - not supported. Later SWIG may call dot and produce the graph image to include in JD and PD \dot - not supported. Later SWIG may call dot and produce the graph image
to include in JD and PD
\dotfile - see note for \dot \dotfile - see note for \dot
\e - translated to <i></i> in JD \e - equivalent \a
\else - see note for \cond \else - see note for \cond
\elseif - see note for \cond \elseif - see note for \cond
\em - translated to <em></em> in JD \em - equivalent to \a
\endcode - see note for \code \endcode - see note for \code
\endcond - translated to 'End of conditional comment: <condition>'. Later \endcond - translated to 'End of conditional comment: <condition>'. Later
SWIG may support definitions of conditions in config file. SWIG may support definitions of conditions in config file.
\enddot - see note for \dot \enddot - see note for \dot
\endhtmlonly - not supported \endhtmlonly - ignored
\endif - see note for \cond \endif - see note for \cond
\endinternal - not supported \endinternal - ignored
\endlatexonly - not supported \endlatexonly - ignored
\endlink - see note for \link \endlink - see note for \link
\endmanonly - not supported \endmanonly - ignored
\endmsc - see note for \msc \endmsc - see note for \msc
\endrtfonly - not supported \endrtfonly - ignored
\endverbatim - see note for \verbatim \endverbatim - see note for \verbatim
\endxmlonly - not supported \endxmlonly - ignored
\enum - ignored (structural command) \enum - ignored (structural command)
\example - translated to 'Example:' in JD and PD \example - translated to 'Example:' in JD and PD
\exception - equivalent to throws \exception - equivalent to throws, but translates to @exception in JD
\extends - not supported \extends - not supported
\f$ \f$
\f[ \f[
\f] \f]
\f{ \f{
\f} \f}
\file \file
\fn \fn
\headerfile \headerfile - not supported
\hideinitializer \hideinitializer - not supported
\htmlinclude \htmlinclude - not supported
\htmlonly \htmlonly - not supported
\if \if - see note for \cond
\ifnot \ifnot - see note for \cond
\image \image - translated to <img/> in JD only when target=HTML, ignored in PD
\implements \implements - not supported
\include \include - not supported
\includelineno \includelineno - not supported
\ingroup \ingroup - not supported. Later swig may print group names as plain text
\internal in comments like 'Code group: something' in both JD and PD
\invariant \internal - ignored
\interface \invariant - ignored
\latexonly \interface - ignored (structural command)
\li \latexonly - ignored
\line \li - trabslated to <li></li> in JD, ignored in PD
\link \line - not supported
\mainpage \link - translated to {@link ...} in JD, ignored in PD
\manonly \mainpage - ignored
\memberof \manonly - ignored
\msc \memberof - not supported
\mscfile \msc - not supported. Later SWIG may call dot and produce the graph image
\n to include in JD and PD
\name \mscfile - see note for \msc
\namespace \n - prints the new line
\nosubgrouping \name - ignored
\note \namespace - included in package-info.java if nspace feature is enabled,
\overload otherwise ignored, ignored in PD
\p \nosubgrouping - ignored
\package \note - ignored in JD, translated to 'Note:' in PD
\page \overload - prints 'This is an overloaded member function, provided for
\par convenience. It differs from the above function only in what
\paragraph argument(s) it accepts.' to the output in both JD and PD
\param \p - equivalent to \c
\post \package - is kept same in JD (it is already a JD tag), ignored in PD
\pre \page - ignored
\private \par - translated to <p alt='title'></p> in JD, 'Title: ...' in PD
\privatesection \paragraph - ignored
\property \param - equivalent to \arg
\protected \post - ignored
\protectedsection \pre - ignored
\protocol \private - ignored
\public \privatesection - ignored
\publicsection \property - ignored
\protected - ignored
\protectedsection - ignored
\protocol - ignored (Objective-C tag)
\public - ignored
\publicsection - ignored
\ref - ignored, not supported by JD and PD \ref - ignored, not supported by JD and PD
\related \related - ignored
\relates \relates - ignored
\relatedalso \relatedalso - ignored
\relatesalso \relatesalso - ignored
\remark \remark - translated to 'Remarks:' in both JD and PD
\remarks \remarks - equivalent to remark
\result \result - translated to @return in JD, 'Return:' in PD
\return \return - equivalent to result
\returns \returns - equivalent to result
\retval \retval - ignored
\rtfonly \rtfonly - ignored
\sa \sa - translated to @see in JD, 'See also:' in PD
\section \section - not supported
\see \see - equivalent to \sa
\short \short - equivalent to \brief
\showinitializer \showinitializer - not supported
\since \since - translated to @since in JD, 'Since:' in PD
\skip \skip - not supported
\skipline \skipline - not supported
\snippet \snippet - not supported
\struct \struct - ignored (structural command)
\subpage \subpage - not supported
\subsection \subsection - not supported
\subsubsection \subsubsection - not supported
\tableofcontents \tableofcontents - not supported
\test \test - ignored
\throw \throw - translated to @throws in JD, 'Throws:' in PD
\throws \throws - equivalent to \throw
\todo \todo - translated to 'TODO:' in both JD and PD
\tparam \tparam - similar to \arg
\typedef \typedef - ignored (structural command)
\union \union - ignored (structural command)
\until \until - not supported
\var \var - ignored (structural command)
\verbatim \verbatim - translated to {@literal ...} in JD, ignored in PD
\verbinclude \verbinclude - ignored
\version \version - translated to @version in JD, 'Version:' in PD
\warning \warning - translated to 'Warning:' in both JD and PD
\weakgroup \weakgroup - not supported
\xmlonly \xmlonly - ignored
\xrefitem \xrefitem - ignored
\$ \$ - this and all the others below: these commands insert single char,
it is escaped as HTML char in JD, kept as-is in PD
\@ \@
\\ \\
\& \&