From 0e2f37bc544dd0fbaad632ef4101dc1d7e44cae0 Mon Sep 17 00:00:00 2001 From: Dmitry Kabak Date: Mon, 9 Jul 2012 10:11:29 +0000 Subject: [PATCH] Extended project plan, now it is also the description of how are the doxygen tags translated git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13269 626c5289-ae23-0410-ae9c-e8d60b6d4f22 --- Doc/Devel/plan-gsoc-2012.txt | 218 ++++++++++++++++++----------------- 1 file changed, 114 insertions(+), 104 deletions(-) diff --git a/Doc/Devel/plan-gsoc-2012.txt b/Doc/Devel/plan-gsoc-2012.txt index 1796bcf78..faf9359f9 100644 --- a/Doc/Devel/plan-gsoc-2012.txt +++ b/Doc/Devel/plan-gsoc-2012.txt @@ -64,19 +64,22 @@ Functionality 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 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 in JD, surrounded with _ in PD \addindex - ignored \addtogroup - ignored \anchor - ignored, not supported by JD and 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 \b - in JD, surrounded with __ in PD - \brief - ignored, content printed out - \bug - ignored, content printed out + \brief - ignored + \bug - ignored \c - translated to in JD, ignored in PD \callgraph - 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 performing copy \copyright - replaced with text 'Copyright' in PD and PD - \date - ignored, content printed out + \date - ignored \def \defgroup \deprecated - translated to @deprecated in JD, 'Deprecated:' in PD - \details - ignored, content printed out + \details - ignored \dir - 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 - \e - translated to in JD + \e - equivalent \a \else - see note for \cond \elseif - see note for \cond - \em - translated to in JD + \em - equivalent to \a \endcode - see note for \code \endcond - translated to 'End of conditional comment: '. Later SWIG may support definitions of conditions in config file. \enddot - see note for \dot - \endhtmlonly - not supported + \endhtmlonly - ignored \endif - see note for \cond - \endinternal - not supported - \endlatexonly - not supported + \endinternal - ignored + \endlatexonly - ignored \endlink - see note for \link - \endmanonly - not supported + \endmanonly - ignored \endmsc - see note for \msc - \endrtfonly - not supported + \endrtfonly - ignored \endverbatim - see note for \verbatim - \endxmlonly - not supported + \endxmlonly - ignored \enum - ignored (structural command) \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 \f$ \f[ \f] \f{ \f} - \file + \file \fn - \headerfile - \hideinitializer - \htmlinclude - \htmlonly - \if - \ifnot - \image - \implements - \include - \includelineno - \ingroup - \internal - \invariant - \interface - \latexonly - \li - \line - \link - \mainpage - \manonly - \memberof - \msc - \mscfile - \n - \name - \namespace - \nosubgrouping - \note - \overload - \p - \package - \page - \par - \paragraph - \param - \post - \pre - \private - \privatesection - \property - \protected - \protectedsection - \protocol - \public - \publicsection + \headerfile - not supported + \hideinitializer - not supported + \htmlinclude - not supported + \htmlonly - not supported + \if - see note for \cond + \ifnot - see note for \cond + \image - translated to in JD only when target=HTML, ignored in PD + \implements - not supported + \include - not supported + \includelineno - not supported + \ingroup - not supported. Later swig may print group names as plain text + in comments like 'Code group: something' in both JD and PD + \internal - ignored + \invariant - ignored + \interface - ignored (structural command) + \latexonly - ignored + \li - trabslated to
  • in JD, ignored in PD + \line - not supported + \link - translated to {@link ...} in JD, ignored in PD + \mainpage - ignored + \manonly - ignored + \memberof - not supported + \msc - not supported. Later SWIG may call dot and produce the graph image + to include in JD and PD + \mscfile - see note for \msc + \n - prints the new line + \name - ignored + \namespace - included in package-info.java if nspace feature is enabled, + otherwise ignored, ignored in PD + \nosubgrouping - ignored + \note - ignored in JD, translated to 'Note:' in PD + \overload - prints 'This is an overloaded member function, provided for + convenience. It differs from the above function only in what + argument(s) it accepts.' to the output in both JD and PD + \p - equivalent to \c + \package - is kept same in JD (it is already a JD tag), ignored in PD + \page - ignored + \par - translated to

    in JD, 'Title: ...' in PD + \paragraph - ignored + \param - equivalent to \arg + \post - ignored + \pre - ignored + \private - ignored + \privatesection - ignored + \property - ignored + \protected - ignored + \protectedsection - ignored + \protocol - ignored (Objective-C tag) + \public - ignored + \publicsection - ignored \ref - ignored, not supported by JD and PD - \related - \relates - \relatedalso - \relatesalso - \remark - \remarks - \result - \return - \returns - \retval - \rtfonly - \sa - \section - \see - \short - \showinitializer - \since - \skip - \skipline - \snippet - \struct - \subpage - \subsection - \subsubsection - \tableofcontents - \test - \throw - \throws - \todo - \tparam - \typedef - \union - \until - \var - \verbatim - \verbinclude - \version - \warning - \weakgroup - \xmlonly - \xrefitem - \$ + \related - ignored + \relates - ignored + \relatedalso - ignored + \relatesalso - ignored + \remark - translated to 'Remarks:' in both JD and PD + \remarks - equivalent to remark + \result - translated to @return in JD, 'Return:' in PD + \return - equivalent to result + \returns - equivalent to result + \retval - ignored + \rtfonly - ignored + \sa - translated to @see in JD, 'See also:' in PD + \section - not supported + \see - equivalent to \sa + \short - equivalent to \brief + \showinitializer - not supported + \since - translated to @since in JD, 'Since:' in PD + \skip - not supported + \skipline - not supported + \snippet - not supported + \struct - ignored (structural command) + \subpage - not supported + \subsection - not supported + \subsubsection - not supported + \tableofcontents - not supported + \test - ignored + \throw - translated to @throws in JD, 'Throws:' in PD + \throws - equivalent to \throw + \todo - translated to 'TODO:' in both JD and PD + \tparam - similar to \arg + \typedef - ignored (structural command) + \union - ignored (structural command) + \until - not supported + \var - ignored (structural command) + \verbatim - translated to {@literal ...} in JD, ignored in PD + \verbinclude - ignored + \version - translated to @version in JD, 'Version:' in PD + \warning - translated to 'Warning:' in both JD and PD + \weakgroup - not supported + \xmlonly - ignored + \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 \@ \\ \&