diff options
Diffstat (limited to 'Doc/Manual/Doxygen.html')
| -rw-r--r-- | Doc/Manual/Doxygen.html | 786 |
1 files changed, 349 insertions, 437 deletions
diff --git a/Doc/Manual/Doxygen.html b/Doc/Manual/Doxygen.html index ff025c047..9f92db91a 100644 --- a/Doc/Manual/Doxygen.html +++ b/Doc/Manual/Doxygen.html @@ -5,7 +5,7 @@ <link rel="stylesheet" type="text/css" href="style.css"> </head> <body bgcolor="#FFFFFF"> -<H1><a name="Doxygen">17 SWIG and Doxygen Translation</a></H1> +<H1><a name="Doxygen">18 SWIG and Doxygen Translation</a></H1> <!-- INDEX --> <div class="sectiontoc"> <ul> @@ -61,13 +61,13 @@ documentation language. Currently only Javadoc and Pydoc is supported. </p> -<H2><a name="Doxygen_translation_overview">17.1 Doxygen translation overview</a></H2> +<H2><a name="Doxygen_translation_overview">18.1 Doxygen translation overview</a></H2> <p> The Doxygen Translation module of SWIG adds an extra layer of functionality to SWIG, allowing automated translation of <a href= -"http://www.doxygen.nl/manual/">Doxygen</a> formatted comments +"https://www.doxygen.nl/manual/">Doxygen</a> formatted comments from input files into a documentation language more suited for the target language. Currently this module only translates into Javadoc and Pydoc for the SWIG Java and Python modules. @@ -77,20 +77,20 @@ a <a href="https://developers.google.com/open-source/gsoc/2008/">Google Summer o Code</a> proposal from Summer 2008. </p> -<H2><a name="Doxygen_file_preparation">17.2 Preparations</a></H2> +<H2><a name="Doxygen_file_preparation">18.2 Preparations</a></H2> <p> To make use of the comment translation system, your documentation comments must be in properly formatted <a href= -"http://www.doxygen.nl/manual/">Doxygen.</a> Doxygen comments can be +"https://www.doxygen.nl/manual/">Doxygen.</a> Doxygen comments can be present in your main SWIG interface file or any header file that it imports. You are advised to be validate that your comments compile properly with Doxygen before you try to translate them. Doxygen itself is a more comprehensive tool and can provide you better feedback for correcting any syntax errors that may be present. Please look at Doxygen's <a href= -"http://www.doxygen.nl/manual/docblocks.html"> Documenting the +"https://www.doxygen.nl/manual/docblocks.html"> Documenting the code</a> for the full comment format specifications. However, SWIG's Doxygen parser will still report many errors and warnings found in comments (like unterminated strings or missing ending tags). @@ -98,7 +98,7 @@ in comments (like unterminated strings or missing ending tags). <p> Currently, the whole subset of Doxygen comment styles is supported -(See <a href="http://www.doxygen.nl/manual/docblocks.html"> +(See <a href="https://www.doxygen.nl/manual/docblocks.html"> Documenting the code</a>). Here they are: </p> @@ -117,14 +117,15 @@ Documenting the code</a>). Here they are: </pre></div> <p> -Also any of the above with '<' added after comment-starting symbol, -like <i>/**<, /*!<, ///<, </i> or <i> //!<</i> will be +Also any of the above with '<tt><</tt>' added after comment-starting symbol, +like <tt>/**<, /*!<, ///<, </tt> or <tt> //!<</tt> will be treated as a post-comment and will be assigned to the code before the comment. -Any number of '*' or '/' within a Doxygen comment is considered to be a -separator and is not included in the final comment, so you may safely use -comments like <i>/*********/</i> or <i>//////////</i>. +Any number of '<tt>*</tt>' or '<tt>/</tt>' within a Doxygen comment is +considered to be a separator and is not included in the final comment, +so you may safely use comments like <tt>/*********/</tt> +or <tt>//////////</tt>. </p> <p> @@ -180,7 +181,7 @@ or enum element comments: <div class="code"><pre> enum E_NUMBERS { - EN_ZERO, ///< The first enum item, gets zero as it's value + EN_ZERO, ///< The first enum item, gets zero as its value EN_ONE, ///< The second, EN_ONE=1 EN_THREE }; @@ -193,7 +194,7 @@ where the comments for a code item are not put directly before or after the code These structural commands are stripped out by SWIG and are not assigned to anything. </p> -<H3><a name="Doxygen_running_swig">17.2.1 Enabling Doxygen translation</a></H3> +<H3><a name="Doxygen_running_swig">18.2.1 Enabling Doxygen translation</a></H3> <p> @@ -202,7 +203,7 @@ enabled using the command line <tt>-doxygen</tt> option for the languages that do support it (currently Java and Python). </p> -<H3><a name="Doxygen_features">17.2.2 Doxygen-specific %feature directives</a></H3> +<H3><a name="Doxygen_features">18.2.2 Doxygen-specific %feature directives</a></H3> <p> @@ -210,7 +211,7 @@ Translation of Doxygen comments is influenced by the following <a href="Customization.html#Customization_features">%feature directives</a>: </p> -<H4><a name="Doxygen_notranslate">17.2.2.1 doxygen:notranslate</a></H4> +<H4><a name="Doxygen_notranslate">18.2.2.1 doxygen:notranslate</a></H4> <p> @@ -222,7 +223,7 @@ instead of the corresponding language tool (<tt>javadoc</tt>, <tt>sphinx</tt>, </p> -<H4><a name="Doxygen_alias">17.2.2.2 doxygen:alias:<command-name></a></H4> +<H4><a name="Doxygen_alias">18.2.2.2 doxygen:alias:<command-name></a></H4> <p> @@ -269,7 +270,7 @@ wrappers of the C++ API. </p> -<H4><a name="Doxygen_ignore">17.2.2.3 doxygen:ignore:<command-name></a></H4> +<H4><a name="Doxygen_ignore">18.2.2.3 doxygen:ignore:<command-name></a></H4> <p> @@ -297,7 +298,7 @@ make much sense for the other languages without explicit ownership management. <p> Doxygen syntax is rather rich and, in addition to simple commands such as <tt>@transferfull</tt>, it is also possible to define commands with arguments. -As explained in <a href="http://www.doxygen.nl/manual/commands.html">Doxygen documentation</a>, +As explained in <a href="https://www.doxygen.nl/manual/commands.html">Doxygen documentation</a>, the arguments can have a range of a single word, everything until the end of line or everything until the end of the next paragraph. Currently, only the "end of line" case is supported using the <tt>range="line"</tt> argument of the @@ -420,7 +421,7 @@ def func(): </pre></div> -<H4><a name="Doxygen_nolinktranslate">17.2.2.4 doxygen:nolinktranslate</a></H4> +<H4><a name="Doxygen_nolinktranslate">18.2.2.4 doxygen:nolinktranslate</a></H4> <p> @@ -429,7 +430,7 @@ This is only applicable to Java at the moment. </p> -<H4><a name="Doxygen_nostripparams">17.2.2.5 doxygen:nostripparams</a></H4> +<H4><a name="Doxygen_nostripparams">18.2.2.5 doxygen:nostripparams</a></H4> <p> @@ -439,14 +440,14 @@ This is only applicable to Java at the moment. </p> -<H3><a name="Doxygen_additional_options">17.2.3 Additional command line options</a></H3> +<H3><a name="Doxygen_additional_options">18.2.3 Additional command line options</a></H3> <p> ALSO TO BE ADDED (Javadoc auto brief?) </p> -<H2><a name="Doxygen_to_javadoc">17.3 Doxygen to Javadoc</a></H2> +<H2><a name="Doxygen_to_javadoc">18.3 Doxygen to Javadoc</a></H2> <p> @@ -455,7 +456,7 @@ automatically placed in the correct locations in the resulting module and proxy files. </p> -<H3><a name="Doxygen_basic_example">17.3.1 Basic example</a></H3> +<H3><a name="Doxygen_basic_example">18.3.1 Basic example</a></H3> <p> @@ -562,7 +563,7 @@ Javadoc translator features summary directives</a>): </p> -<H3><a name="Doxygen_javadoc_tags">17.3.2 Javadoc tags</a></H3> +<H3><a name="Doxygen_javadoc_tags">18.3.2 Javadoc tags</a></H3> <p> @@ -606,6 +607,10 @@ Here is the list of all Doxygen tags and the description of how they are transla <td>translated to {@code ...}</td> </tr> <tr> +<td>\code{<ext>}</td> +<td>translated to {@code ...}; code language extension is ignored</td> +</tr> +<tr> <td>\cond</td> <td>translated to 'Conditional comment: <condition>'</td> </tr> @@ -683,7 +688,7 @@ Here is the list of all Doxygen tags and the description of how they are transla </tr> <tr> <td>\n</td> -<td>replaced with new line char</td> +<td>replaced with newline char</td> </tr> <tr> <td>\note</td> @@ -706,6 +711,10 @@ Here is the list of all Doxygen tags and the description of how they are transla <td>translated to @param</td> </tr> <tr> +<td>\param[<dir>]</td> +<td>translated to @param; parameter direction ('in'; 'out'; or 'in,out') is ignored</td> +</tr> +<tr> <td>\remark</td> <td>replaced with 'Remarks:'</td> </tr> @@ -816,7 +825,7 @@ Here is the list of all Doxygen tags and the description of how they are transla </table> </div> -<H3><a name="Doxygen_unsupported_tags">17.3.3 Unsupported tags</a></H3> +<H3><a name="Doxygen_unsupported_tags">18.3.3 Unsupported tags</a></H3> <p> @@ -829,155 +838,107 @@ These are suppressed with their content just printed out (if the tag has any sense, typically text content). Here is the list of these tags: </p> + <div class="diagram"> -<table border="0" summary="Unsupported Java Doxygen Tags"> -<tr> - <th align="left">Unsupported Doxygen tags</th> -</tr> -<tr> -<td>\addindex</td> -<td>\addtogroup</td> -<td>\anchor</td> -<td>\attention</td> -</tr> -<tr> -<td>\brief</td> -<td>\bug</td> -<td>\callgraph</td> -<td>\callergraph</td> -</tr> -<tr> -<td>\class</td> -<td>\copybrief</td> -<td>\copydetails</td> -<td>\copydoc</td> -</tr> -<tr> -<td>\date</td> -<td>\def</td> -<td>\defgroup</td> -<td>\details</td> -</tr> -<tr> -<td>\dir</td> -<td>\dontinclude</td> -<td>\dot</td> -<td>\dotfile</td> -</tr> -<tr> -<td>\enddot</td> -<td>\endhtmlonly</td> -<td>\endinternal</td> -<td>\endlatexonly</td> -</tr> -<tr> -<td>\endmanonly</td> -<td>\endmsc</td> -<td>\endrtfonly</td> -<td>\endxmlonly</td> -</tr> -<tr> -<td>\enum</td> -<td>\example</td> -<td>\extends</td> -</tr> -<tr> -<td>\file</td> -<td>\fn</td> -<td>\headerfile</td> -<td>\hideinitializer</td> -</tr> -<tr> -<td>\htmlinclude</td> -<td>\htmlonly</td> -<td>\implements</td> -<td>\include</td> -</tr> -<tr> -<td>\includelineno</td> -<td>\ingroup</td> -<td>\internal</td> -<td>\invariant</td> -</tr> -<tr> -<td>\interface</td> -<td>\latexonly</td> -<td>\line</td> -<td>\mainpage</td> -</tr> -<tr> -<td>\manonly</td> -<td>\memberof</td> -<td>\msc</td> -<td>\mscfile</td> -</tr> -<tr> -<td>\name</td> -<td>\namespace</td> -<td>\nosubgrouping</td> -<td>\package</td> -</tr> -<tr> -<td>\page</td> -<td>\paragraph</td> -<td>\post</td> -<td>\pre</td> -</tr> -<tr> -<td>\private</td> -<td>\privatesection</td> -<td>\property</td> -<td>\protected</td> -</tr> -<tr> -<td>\protectedsection</td> -<td>\protocol</td> -<td>\public</td> -<td>\publicsection</td> -</tr> -<tr> -<td>\ref</td> -<td>\related</td> -<td>\relates</td> -<td>\relatedalso</td> -</tr> -<tr> -<td>\relatesalso</td> -<td>\retval</td> -<td>\rtfonly</td> -<td>\section</td> -</tr> -<tr> -<td>\short</td> -<td>\showinitializer</td> -<td>\skip</td> -<td>\skipline</td> -</tr> -<tr> -<td>\snippet</td> -<td>\struct</td> -<td>\subpage</td> -<td>\subsection</td> -</tr> -<tr> -<td>\subsubsection</td> -<td>\tableofcontents</td> -<td>\test</td> -<td>\typedef</td> -</tr> -<tr> -<td>\union</td> -<td>\until</td> -<td>\var</td> -<td>\verbinclude</td> -</tr> -<tr> -<td>\weakgroup</td> -<td>\xmlonly</td> -<td>\xrefitem</td> -<td>\category</td> -</tr> -</table> + <b>Unsupported Doxygen tags</b> + + <ul style="list-style-type:none;column-count:4;"> + <li>\addindex</li> + <li>\addtogroup</li> + <li>\anchor</li> + <li>\attention</li> + <li>\brief</li> + <li>\bug</li> + <li>\callergraph</li> + <li>\callgraph</li> + <li>\category</li> + <li>\class</li> + <li>\copybrief</li> + <li>\copydetails</li> + <li>\copydoc</li> + <li>\date</li> + <li>\def</li> + <li>\defgroup</li> + <li>\details</li> + <li>\dir</li> + <li>\dontinclude</li> + <li>\dot</li> + <li>\dotfile</li> + <li>\enddot</li> + <li>\endhtmlonly</li> + <li>\endinternal</li> + <li>\endlatexonly</li> + <li>\endmanonly</li> + <li>\endmsc</li> + <li>\endrtfonly</li> + <li>\endxmlonly</li> + <li>\enum</li> + <li>\example</li> + <li>\extends</li> + <li>\file</li> + <li>\fn</li> + <li>\headerfile</li> + <li>\hideinitializer</li> + <li>\htmlinclude</li> + <li>\htmlonly</li> + <li>\implements</li> + <li>\include</li> + <li>\includelineno</li> + <li>\ingroup</li> + <li>\interface</li> + <li>\internal</li> + <li>\invariant</li> + <li>\latexonly</li> + <li>\line</li> + <li>\mainpage</li> + <li>\manonly</li> + <li>\memberof</li> + <li>\msc</li> + <li>\mscfile</li> + <li>\name</li> + <li>\namespace</li> + <li>\nosubgrouping</li> + <li>\package</li> + <li>\page</li> + <li>\paragraph</li> + <li>\post</li> + <li>\pre</li> + <li>\private</li> + <li>\privatesection</li> + <li>\property</li> + <li>\protected</li> + <li>\protectedsection</li> + <li>\protocol</li> + <li>\public</li> + <li>\publicsection</li> + <li>\ref</li> + <li>\related</li> + <li>\relatedalso</li> + <li>\relates</li> + <li>\relatesalso</li> + <li>\retval</li> + <li>\rtfonly</li> + <li>\section</li> + <li>\short</li> + <li>\showinitializer</li> + <li>\skip</li> + <li>\skipline</li> + <li>\snippet</li> + <li>\struct</li> + <li>\subpage</li> + <li>\subsection</li> + <li>\subsubsection</li> + <li>\tableofcontents</li> + <li>\test</li> + <li>\typedef</li> + <li>\union</li> + <li>\until</li> + <li>\var</li> + <li>\verbinclude</li> + <li>\weakgroup</li> + <li>\xmlonly</li> + <li>\xrefitem</li> + </ul> </div> <p> @@ -987,79 +948,58 @@ comment, the whole comment block is ignored: <!-- see parser.y, function isStructuralDoxygen() --> </p> -<div class="diagram"> -<table border="0" summary="Ignored Java Doxygen Tags"> -<tr> - <th align="left">Ignored Doxygen tags</th> -</tr> -<tr> -<td>\addtogroup</td> -<td>\callgraph</td> -<td>\callergraph</td> -<td>\category</td> -</tr> -<tr> -<td>\class</td> -<td>\def</td> -<td>\defgroup</td> -<td>\dir</td> -</tr> -<tr> -<td>\enum</td> -<td>\example</td> -<td>\file</td> -<td>\fn</td> -</tr> -<tr> -<td>\headerfile</td> -<td>\hideinitializer</td> -<td>\interface</td> -<td>\internal</td> -</tr> -<tr> -<td>\mainpage</td> -<td>\name</td> -<td>\namespace</td> -<td>\nosubgrouping</td> -</tr> -<tr> -<td>\overload</td> -<td>\package</td> -<td>\page</td> -<td>\property</td> -</tr> -<tr> -<td>\protocol</td> -<td>\relates</td> -<td>\relatesalso</td> -<td>\showinitializer</td> -</tr> -<tr> -<td>\struct</td> -<td>\name</td> -<td>\namespace</td> -<td>\nosubgrouping</td> -</tr> -<tr> -<td>\typedef</td> -<td>\union</td> -<td>\var</td> -<td>\weakgroup</td> -</tr> -</table> +<div class="diagram"> + <b>Ignored Doxygen tags</b> + + <ul style="list-style-type:none;column-count:4;"> + <li>\addtogroup</li> + <li>\callergraph</li> + <li>\callgraph</li> + <li>\category</li> + <li>\class</li> + <li>\def</li> + <li>\defgroup</li> + <li>\dir</li> + <li>\enum</li> + <li>\example</li> + <li>\file</li> + <li>\fn</li> + <li>\headerfile</li> + <li>\hideinitializer</li> + <li>\interface</li> + <li>\internal</li> + <li>\mainpage</li> + <li>\name</li> + <li>\namespace</li> + <li>\nosubgrouping</li> + <li>\overload</li> + <li>\package</li> + <li>\page</li> + <li>\property</li> + <li>\protocol</li> + <li>\relates</li> + <li>\relatesalso</li> + <li>\showinitializer</li> + <li>\struct</li> + <li>\typedef</li> + <li>\union</li> + <li>\var</li> + <li>\weakgroup</li> + </ul> </div> + -<H3><a name="Doxygen_further_details">17.3.4 Further details</a></H3> +<H3><a name="Doxygen_further_details">18.3.4 Further details</a></H3> <p> TO BE ADDED. </p> -<H2><a name="Doxygen_to_pydoc">17.4 Doxygen to Pydoc</a></H2> +<H2><a name="Doxygen_to_pydoc">18.4 Doxygen to Pydoc</a></H2> <p> @@ -1070,7 +1010,7 @@ Doxygen or Javadoc, so most of Doxygen commands are translated by merely copying the appropriate command text. </p> -<H3><a name="Doxygen_python_basic_example">17.4.1 Basic example</a></H3> +<H3><a name="Doxygen_python_basic_example">18.4.1 Basic example</a></H3> <p> @@ -1139,7 +1079,7 @@ class Shape(_object): <p> If any parameters of a function or a method are documented in the Doxygen comment, their description is copied into the generated output using -<a href="http://sphinx-doc.org/">Sphinx </a> documentation conventions. For example +<a href="https://www.sphinx-doc.org/">Sphinx </a> documentation conventions. For example </p> <div class="code"><pre> /** @@ -1174,7 +1114,7 @@ name of the type with namespace scope delimiters (<tt>::</tt>) replaced with a d change this, you can define your own typemaps for the custom types, e.g: </p> <div class="code"><pre> -%typemap(doctype) MyDate "datetime.date"; +%typemap(doctype) MyDate "datetime.date" </pre></div> <p> @@ -1227,13 +1167,13 @@ completely (doxygen:notranslate feature). Then SWIG will just copy the comments to the proxy file and reformat them if needed, but all the comment content will be left as is. As Doxygen doesn't support special commands in Python comments -(see <a href="http://www.doxygen.nl/manual/docblocks.html#pythonblocks">Doxygen +(see <a href="https://www.doxygen.nl/manual/docblocks.html#pythonblocks">Doxygen docs</a>), you may want to use some tool like doxypy (<a href="https://pypi.org/project/doxypy/">doxypy</a>) to do the work. </p> -<H3><a name="Doxygen_pydoc_tags">17.4.2 Pydoc translator</a></H3> +<H3><a name="Doxygen_pydoc_tags">18.4.2 Pydoc translator</a></H3> <p> @@ -1246,11 +1186,11 @@ Here is the list of all Doxygen tags and the description of how they are transla </tr> <tr> <td>\a</td> -<td>wrapped with '_'</td> +<td>wrapped with '*'</td> </tr> <tr> <td>\arg</td> -<td>prepended with ' --'</td> +<td>prepended with '* '</td> </tr> <tr> <td>\author</td> @@ -1258,17 +1198,29 @@ Here is the list of all Doxygen tags and the description of how they are transla </tr> <tr> <td>\authors</td> -<td>prints 'Author:'</td> +<td>prints 'Authors:'</td> </tr> <tr> <td>\b</td> -<td>wrapped with '__'</td> +<td>wrapped with '**'</td> +</tr> +<tr> +<td>\c</td> +<td>wrapped with '``'</td> </tr> <tr> <td>\cite</td> <td>wrapped with single quotes</td> </tr> <tr> +<td>\code</td> +<td>replaced with '.. code-block:: c++'</td> +</tr> +<tr> +<td>\code{<ext>}</td> +<td>replaced with '.. code-block:: <lang>', where the following doxygen code languages are recognized: .c -> C, .py -> python, .java > java</td> +</tr> +<tr> <td>\cond</td> <td>translated to 'Conditional comment: <condition>'</td> </tr> @@ -1282,7 +1234,7 @@ Here is the list of all Doxygen tags and the description of how they are transla </tr> <tr> <td>\e</td> -<td>wrapped with '_'</td> +<td>wrapped with '*'</td> </tr> <tr> <td>\else</td> @@ -1294,7 +1246,7 @@ Here is the list of all Doxygen tags and the description of how they are transla </tr> <tr> <td>\em</td> -<td>wrapped with '_'</td> +<td>wrapped with '*'</td> </tr> <tr> <td>\endcond</td> @@ -1305,8 +1257,24 @@ Here is the list of all Doxygen tags and the description of how they are transla <td>replaced with '}'</td> </tr> <tr> +<td>\example</td> +<td>replaced with 'Example:'</td> +</tr> +<tr> <td>\exception</td> -<td>replaced with 'Throws:'</td> +<td>replaced with ':raises:'</td> +</tr> +<tr> +<td>\f$</td> +<td>rendered using ':math:``'</td> +</tr> +<tr> +<td>\f[</td> +<td>rendered using '.. math::'</td> +</tr> +<tr> +<td>\f{</td> +<td>rendered using '.. math::'</td> </tr> <tr> <td>\if</td> @@ -1318,11 +1286,11 @@ Here is the list of all Doxygen tags and the description of how they are transla </tr> <tr> <td>\li</td> -<td>prepended with ' --'</td> +<td>prepended with '* '</td> </tr> <tr> <td>\n</td> -<td>replaced with new line char</td> +<td>replaced with newline char</td> </tr> <tr> <td>\note</td> @@ -1333,12 +1301,20 @@ Here is the list of all Doxygen tags and the description of how they are transla <td>prints 'This is an overloaded ...' according to Doxygen docs</td> </tr> <tr> +<td>\p</td> +<td>wrapped with '``'</td> +</tr> +<tr> <td>\par</td> <td>replaced with 'Title: ...'</td> </tr> <tr> <td>\param</td> -<td>translated to 'Arguments:\n param(type) --description'</td> +<td>add ':type:' and ':param:' directives</td> +</tr> +<tr> +<td>\param[<dir>]</td> +<td>same as \param, but direction ('in'; 'out'; 'in,out') is included in ':type:' directive</td> </tr> <tr> <td>\remark</td> @@ -1350,15 +1326,15 @@ Here is the list of all Doxygen tags and the description of how they are transla </tr> <tr> <td>\result</td> -<td>replaced with 'Result:'</td> +<td>add ':rtype:' and ':return:' directives</td> </tr> <tr> <td>\return</td> -<td>replaced with 'Result:'</td> +<td>add ':rtype:' and ':return:' directives</td> </tr> <tr> <td>\returns</td> -<td>replaced with 'Result:'</td> +<td>add ':rtype:' and ':return:' directives</td> </tr> <tr> <td>\sa</td> @@ -1374,11 +1350,11 @@ Here is the list of all Doxygen tags and the description of how they are transla </tr> <tr> <td>\throw</td> -<td>replaced with 'Throws:'</td> +<td>replaced with ':raises:'</td> </tr> <tr> <td>\throws</td> -<td>replaced wih 'Throws:'</td> +<td>replaced with ':raises:'</td> </tr> <tr> <td>\todo</td> @@ -1386,7 +1362,11 @@ Here is the list of all Doxygen tags and the description of how they are transla </tr> <tr> <td>\tparam</td> -<td>translated to 'Arguments:\n param(type) --description'</td> +<td>add ':type:' and ':param:' directives</td> +</tr> +<tr> +<td>\verbatim</td> +<td>content copied verbatim</td> </tr> <tr> <td>\version</td> @@ -1447,7 +1427,7 @@ Here is the list of all Doxygen tags and the description of how they are transla </table> </div> -<H3><a name="Doxygen_python_unsupported_tags">17.4.3 Unsupported tags</a></H3> +<H3><a name="Doxygen_python_unsupported_tags">18.4.3 Unsupported tags</a></H3> <p> @@ -1458,187 +1438,119 @@ are suppressed with their content just printed out (if it has any sense, typically text content). Here is the list of these tags: </p> + <div class="diagram"> -<table border="0" summary="Unsupported Python Doxygen Tags"> -<tr> - <th align="left">Unsupported Doxygen tags</th> -</tr> -<tr> -<td>\addindex</td> -<td>\addtogroup</td> -<td>\anchor</td> -<td>\attention</td> -</tr> -<tr> -<td>\brief</td> -<td>\bug</td> -<td>\callgraph</td> -<td>\callergraph</td> -</tr> -<tr> -<td>\class</td> -<td>\copybrief</td> -<td>\copydetails</td> -<td>\copydoc</td> -</tr> -<tr> -<td>\date</td> -<td>\def</td> -<td>\defgroup</td> -<td>\details</td> -</tr> -<tr> -<td>\dir</td> -<td>\dontinclude</td> -<td>\dot</td> -<td>\dotfile</td> -</tr> -<tr> -<td>\code</td> -<td>\endcode</td> -<td>\endverbatim</td> -<td>\endlink</td> -</tr> -<tr> -<td>\enddot</td> -<td>\endhtmlonly</td> -<td>\endinternal</td> -<td>\endlatexonly</td> -</tr> -<tr> -<td>\endmanonly</td> -<td>\endmsc</td> -<td>\endrtfonly</td> -<td>\endxmlonly</td> -</tr> -<tr> -<td>\enum</td> -<td>\example</td> -<td>\extends</td> -<td>\f$</td> -</tr> -<tr> -<td>\f[</td> -<td>\f]</td> -<td>\f{</td> -<td>\f}</td> -</tr> -<tr> -<td>\file</td> -<td>\fn</td> -<td>\headerfile</td> -<td>\hideinitializer</td> -</tr> -<tr> -<td>\htmlinclude</td> -<td>\htmlonly</td> -<td>\implements</td> -<td>\include</td> -</tr> -<tr> -<td>\image</td> -<td>\link</td> -<td>\verbatim</td> -<td>\p</td> -</tr> -<tr> -<td>\includelineno</td> -<td>\ingroup</td> -<td>\internal</td> -<td>\invariant</td> -</tr> -<tr> -<td>\interface</td> -<td>\latexonly</td> -<td>\line</td> -<td>\mainpage</td> -</tr> -<tr> -<td>\manonly</td> -<td>\memberof</td> -<td>\msc</td> -<td>\mscfile</td> -</tr> -<tr> -<td>\name</td> -<td>\namespace</td> -<td>\nosubgrouping</td> -<td>\package</td> -</tr> -<tr> -<td>\page</td> -<td>\paragraph</td> -<td>\post</td> -<td>\pre</td> -</tr> -<tr> -<td>\private</td> -<td>\privatesection</td> -<td>\property</td> -<td>\protected</td> -</tr> -<tr> -<td>\protectedsection</td> -<td>\protocol</td> -<td>\public</td> -<td>\publicsection</td> -</tr> -<tr> -<td>\ref</td> -<td>\related</td> -<td>\relates</td> -<td>\relatedalso</td> -</tr> -<tr> -<td>\relatesalso</td> -<td>\retval</td> -<td>\rtfonly</td> -<td>\section</td> -</tr> -<tr> -<td>\short</td> -<td>\showinitializer</td> -<td>\skip</td> -<td>\skipline</td> -</tr> -<tr> -<td>\snippet</td> -<td>\struct</td> -<td>\subpage</td> -<td>\subsection</td> -</tr> -<tr> -<td>\subsubsection</td> -<td>\tableofcontents</td> -<td>\test</td> -<td>\typedef</td> -</tr> -<tr> -<td>\union</td> -<td>\until</td> -<td>\var</td> -<td>\verbinclude</td> -</tr> -<tr> -<td>\weakgroup</td> -<td>\xmlonly</td> -<td>\xrefitem</td> -<td>\category</td> -</tr> -<tr> -<td>\c</td> -</tr> -</table> + <b>Unsupported Python Doxygen tags</b> + + <ul style="list-style-type:none;column-count:4;"> + <li>\addindex</li> + <li>\addtogroup</li> + <li>\anchor</li> + <li>\attention</li> + <li>\brief</li> + <li>\bug</li> + <li>\callergraph</li> + <li>\callgraph</li> + <li>\category</li> + <li>\class</li> + <li>\copybrief</li> + <li>\copydetails</li> + <li>\copydoc</li> + <li>\date</li> + <li>\def</li> + <li>\defgroup</li> + <li>\details</li> + <li>\dir</li> + <li>\dontinclude</li> + <li>\dot</li> + <li>\dotfile</li> + <li>\enddot</li> + <li>\endhtmlonly</li> + <li>\endinternal</li> + <li>\endlatexonly</li> + <li>\endlink</li> + <li>\endmanonly</li> + <li>\endmsc</li> + <li>\endrtfonly</li> + <li>\endxmlonly</li> + <li>\enum</li> + <li>\extends</li> + <li>\file</li> + <li>\fn</li> + <li>\headerfile</li> + <li>\hideinitializer</li> + <li>\htmlinclude</li> + <li>\htmlonly</li> + <li>\image</li> + <li>\implements</li> + <li>\include</li> + <li>\includelineno</li> + <li>\ingroup</li> + <li>\interface</li> + <li>\internal</li> + <li>\invariant</li> + <li>\latexonly</li> + <li>\line</li> + <li>\link</li> + <li>\mainpage</li> + <li>\manonly</li> + <li>\memberof</li> + <li>\msc</li> + <li>\mscfile</li> + <li>\name</li> + <li>\namespace</li> + <li>\nosubgrouping</li> + <li>\package</li> + <li>\page</li> + <li>\paragraph</li> + <li>\post</li> + <li>\pre</li> + <li>\private</li> + <li>\privatesection</li> + <li>\property</li> + <li>\protected</li> + <li>\protectedsection</li> + <li>\protocol</li> + <li>\public</li> + <li>\publicsection</li> + <li>\ref</li> + <li>\related</li> + <li>\relatedalso</li> + <li>\relates</li> + <li>\relatesalso</li> + <li>\retval</li> + <li>\rtfonly</li> + <li>\section</li> + <li>\short</li> + <li>\showinitializer</li> + <li>\skip</li> + <li>\skipline</li> + <li>\snippet</li> + <li>\struct</li> + <li>\subpage</li> + <li>\subsection</li> + <li>\subsubsection</li> + <li>\tableofcontents</li> + <li>\test</li> + <li>\typedef</li> + <li>\union</li> + <li>\until</li> + <li>\var</li> + <li>\verbinclude</li> + <li>\weakgroup</li> + <li>\xmlonly</li> + <li>\xrefitem</li> + </ul> </div> -<H3><a name="Doxygen_python_further_details">17.4.4 Further details</a></H3> +<H3><a name="Doxygen_python_further_details">18.4.4 Further details</a></H3> <p> TO BE ADDED. </p> -<H2><a name="Doxygen_troubleshooting">17.5 Troubleshooting</a></H2> +<H2><a name="Doxygen_troubleshooting">18.5 Troubleshooting</a></H2> <p> @@ -1660,7 +1572,7 @@ include the option and fix problems with Doxygen comments. </p> -<H3><a name="troubleshooting_ifndef">17.5.1 Problem with conditional compilation</a></H3> +<H3><a name="troubleshooting_ifndef">18.5.1 Problem with conditional compilation</a></H3> <p> @@ -1700,14 +1612,14 @@ class A { </pre></div> -<H2><a name="Doxygen_developer_details">17.6 Developer information</a></H2> +<H2><a name="Doxygen_developer_details">18.6 Developer information</a></H2> <p> This section contains information for developers enhancing the Doxygen translator. </p> -<H3><a name="Doxygen_translator_design">17.6.1 Doxygen translator design</a></H3> +<H3><a name="Doxygen_translator_design">18.6.1 Doxygen translator design</a></H3> <p> @@ -1733,7 +1645,7 @@ class for translation into the target documentation language. For example, <tt>JavaDocConverter</tt> is the Javadoc module class. </p> -<H3><a name="Doxygen_debugging_commands">17.6.2 Debugging the Doxygen parser and translator</a></H3> +<H3><a name="Doxygen_debugging_commands">18.6.2 Debugging the Doxygen parser and translator</a></H3> <p> @@ -1746,7 +1658,7 @@ detailed debug information printing. -debug-doxygen-translator - Display Doxygen translator module debugging information </pre></div> -<H3><a name="Doxygen_tests">17.6.3 Tests</a></H3> +<H3><a name="Doxygen_tests">18.6.3 Tests</a></H3> <p> @@ -1798,7 +1710,7 @@ Runtime tests in Python are just plain string comparisons of the __doc__ properties. </p> -<H2><a name="Doxygen_language_extension">17.7 Extending to other languages</a></H2> +<H2><a name="Doxygen_language_extension">18.7 Extending to other languages</a></H2> <p> |