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

Update html chapter numbering for added Doxygen chapter

Browse source
This commit is contained in:
William S Fulton 2018-05-24 18:36:20 +01:00
commit 4cdca98709
31 changed files with 1062 additions and 1039 deletions
Download patch file Download diff file Expand all files Collapse all files

100
Doc/Manual/Doxygen.html
View file

@ -5,38 +5,45 @@
<link rel="stylesheet" type="text/css" href="style.css">
</head>
<body bgcolor="#FFFFFF">
<H1><a name="Doxygen"></a>39 SWIG and Doxygen Translation</H1>
<H1><a name="Doxygen">16 SWIG and Doxygen Translation</a></H1>
<!-- INDEX -->
<div class="sectiontoc">
<ul>
<li><a href="#Doxygen_translation_overview">Doxygen Translation Overview</a>
<li><a href="#Doxygen_translation_overview">Doxygen translation overview</a>
<li><a href="#Doxygen_file_preparation">Preparations</a>
<ul>
<li><a href="#Doxygen_running_swig">Enabling Doxygen Translation</a>
<li><a href="#Doxygen_additional_options">Additional Command Line Options</a>
<li><a href="#Doxygen_features">Doxygen-specific %feature Directives</a>
</ul>
<li><a href="#Doxygen_to_javadoc">Doxygen To Javadoc</a>
<li><a href="#Doxygen_running_swig">Enabling Doxygen translation</a>
<li><a href="#Doxygen_features">Doxygen-specific %feature directives</a>
<ul>
<li><a href="#Doxygen_basic_example">Basic Example</a>
<li><a href="#Doxygen_javadoc_tags">Javadoc Tags</a>
<li><a href="#Doxygen_notranslate">doxygen:notranslate</a>
<li><a href="#Doxygen_alias">doxygen:alias:&lt;command-name&gt;</a>
<li><a href="#Doxygen_ignore">doxygen:ignore:&lt;command-name&gt;</a>
<li><a href="#Doxygen_nolinktranslate">doxygen:nolinktranslate (Java-only currently)</a>
<li><a href="#Doxygen_nostripparams">doxygen:nostripparams (Java-only currently)</a>
</ul>
<li><a href="#Doxygen_additional_options">Additional command line options</a>
</ul>
<li><a href="#Doxygen_to_javadoc">Doxygen to Javadoc</a>
<ul>
<li><a href="#Doxygen_basic_example">Basic example</a>
<li><a href="#Doxygen_javadoc_tags">Javadoc tags</a>
<li><a href="#Doxygen_unsupported_tags">Unsupported tags</a>
<li><a href="#Doxygen_further_details">Further Details</a>
<li><a href="#Doxygen_further_details">Further details</a>
</ul>
<li><a href="#Doxygen_to_pydoc">Doxygen To Pydoc</a>
<li><a href="#Doxygen_to_pydoc">Doxygen to Pydoc</a>
<ul>
<li><a href="#Doxygen_python_basic_example">Basic Example</a>
<li><a href="#Doxygen_python_basic_example">Basic example</a>
<li><a href="#Doxygen_pydoc_tags">Pydoc translator</a>
<li><a href="#Doxygen_python_unsupported_tags">Unsupported tags</a>
<li><a href="#Doxygen_python_further_details">Further Details</a>
<li><a href="#Doxygen_python_further_details">Further details</a>
</ul>
<li><a href="#Doxygen_developer_details">Developer Information</a>
<li><a href="#Doxygen_developer_details">Developer information</a>
<ul>
<li><a href="#Doxygen_translator_design">Doxygen Translator Design</a>
<li><a href="#Doxygen_debugging_commands">Debugging Doxygen parser and translator</a>
<li><a href="#Doxygen_debugging_commands">Tests</a>
<li><a href="#Doxygen_translator_design">Doxygen translator design</a>
<li><a href="#Doxygen_debugging_commands">Debugging the Doxygen parser and translator</a>
<li><a href="#Doxygen_tests">Tests</a>
</ul>
<li><a href="#Doxygen_language_extension">Extending to Other Languages</a>
<li><a href="#Doxygen_language_extension">Extending to other languages</a>
</ul>
</div>
<!-- INDEX -->
@ -50,7 +57,7 @@ documentation language. Currently only Javadoc and Pydoc is
supported.
</p>
<H2><a name="Doxygen_translation_overview"></a>39.1 Doxygen translation overview</H2>
<H2><a name="Doxygen_translation_overview">16.1 Doxygen translation overview</a></H2>
<p>
@ -66,7 +73,7 @@ a <a href="http://code.google.com/soc/2008/">Google Summer of
Code</a> proposal from Summer 2008.
</p>
<H2><a name="Doxygen_file_preparation"></a>39.2 Preparations</H2>
<H2><a name="Doxygen_file_preparation">16.2 Preparations</a></H2>
<p>
@ -182,7 +189,8 @@ 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"></a>39.2.1 Enabling Doxygen translation</H3>
<H3><a name="Doxygen_running_swig">16.2.1 Enabling Doxygen translation</a></H3>
<p>
Doxygen comments translation is disabled by default and needs to be explicitly
@ -190,14 +198,16 @@ enabled using the command line <tt>-doxygen</tt> switch for the languages that
do support it (currently Java and Python).
</p>
<H3><a name="Doxygen_features"></a>39.2.2 Doxygen-specific %feature directives</H3>
<H3><a name="Doxygen_features">16.2.2 Doxygen-specific %feature directives</a></H3>
<p>
Translation of Doxygen comments is influenced by the following <a
href="Customization.html#Customization_features">%feature directives</a>:
</p>
<h4><a name="Doxygen_notranslate"></a>doxygen:notranslate</h4>
<H4><a name="Doxygen_notranslate">16.2.2.1 doxygen:notranslate</a></H4>
<p>
Turns off translation of Doxygen comments to the target language syntax: the
@ -208,7 +218,8 @@ instead of the corresponding language tool (<tt>javadoc</tt>, <tt>sphinx</tt>,
</p>
<h4><a name="Doxygen_alias"></a>doxygen:alias:&lt;command-name&gt;</h4>
<H4><a name="Doxygen_alias">16.2.2.2 doxygen:alias:&lt;command-name&gt;</a></H4>
<p>
Specify an alias for a Doxygen command with the given name. This can be useful
@ -254,7 +265,8 @@ wrappers of the C++ API.
</p>
<h4><a name="Doxygen_ignore"></a>doxygen:ignore:&lt;command-name&gt;</h4>
<H4><a name="Doxygen_ignore">16.2.2.3 doxygen:ignore:&lt;command-name&gt;</a></H4>
<p>
This feature makes it possible to just ignore an unknown Doxygen command, instead of
@ -404,14 +416,16 @@ def func():
</pre></div>
<h4><a name="Doxygen_nolinktranslate"></a>doxygen:nolinktranslate (Java-only currently)</h4>
<H4><a name="Doxygen_nolinktranslate">16.2.2.4 doxygen:nolinktranslate (Java-only currently)</a></H4>
<p>
Turn off automatic link-objects translation.
</p>
<h4><a name="Doxygen_nostripparams"></a>doxygen:nostripparams (Java-only currently)</h4>
<H4><a name="Doxygen_nostripparams">16.2.2.5 doxygen:nostripparams (Java-only currently)</a></H4>
<p>
Turn off stripping of <tt>@param</tt> and <tt>@tparam</tt>
@ -419,14 +433,14 @@ Doxygen commands if the parameter is not found in the function signature.
</p>
<H3><a name="Doxygen_additional_options"></a>39.2.3 Additional command line options</H3>
<H3><a name="Doxygen_additional_options">16.2.3 Additional command line options</a></H3>
<p>
ALSO TO BE ADDED (Javadoc auto brief?)
</p>
<H2><a name="Doxygen_to_javadoc"></a>39.3 Doxygen to Javadoc</H2>
<H2><a name="Doxygen_to_javadoc">16.3 Doxygen to Javadoc</a></H2>
<p>
@ -435,7 +449,7 @@ automatically placed in the correct locations in the resulting module
and proxy files.
</p>
<H3><a name="Doxygen_basic_example"></a>39.3.1 Basic example</H3>
<H3><a name="Doxygen_basic_example">16.3.1 Basic example</a></H3>
<p>
@ -542,7 +556,7 @@ Javadoc translator features summary
directives</a>):
</p>
<H3><a name="Doxygen_javadoc_tags"></a>39.3.2 Javadoc tags</H3>
<H3><a name="Doxygen_javadoc_tags">16.3.2 Javadoc tags</a></H3>
<p>
@ -796,7 +810,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"></a>39.3.3 Unsupported tags</H3>
<H3><a name="Doxygen_unsupported_tags">16.3.3 Unsupported tags</a></H3>
<p>
@ -1032,14 +1046,14 @@ comment, the whole comment block is ignored:
<H3><a name="Doxygen_further_details"></a>39.3.4 Further details</H3>
<H3><a name="Doxygen_further_details">16.3.4 Further details</a></H3>
<p>
TO BE ADDED.
</p>
<H2><a name="Doxygen_to_pydoc"></a>39.4 Doxygen to Pydoc</H2>
<H2><a name="Doxygen_to_pydoc">16.4 Doxygen to Pydoc</a></H2>
<p>
@ -1050,7 +1064,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"></a>39.4.1 Basic example</H3>
<H3><a name="Doxygen_python_basic_example">16.4.1 Basic example</a></H3>
<p>
@ -1213,7 +1227,7 @@ docs</a>), you may want to use some tool like doxypy
to do the work.
</p>
<H3><a name="Doxygen_pydoc_tags"></a>39.4.2 Pydoc translator</H3>
<H3><a name="Doxygen_pydoc_tags">16.4.2 Pydoc translator</a></H3>
<p>
@ -1427,7 +1441,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"></a>39.4.3 Unsupported tags</H3>
<H3><a name="Doxygen_python_unsupported_tags">16.4.3 Unsupported tags</a></H3>
<p>
@ -1611,21 +1625,21 @@ Here is the list of these tags:
</table>
</div>
<H3><a name="Doxygen_python_further_details"></a>39.4.4 Further details</H3>
<H3><a name="Doxygen_python_further_details">16.4.4 Further details</a></H3>
<p>
TO BE ADDED.
</p>
<H2><a name="Doxygen_developer_details"></a>39.5 Developer information</H2>
<H2><a name="Doxygen_developer_details">16.5 Developer information</a></H2>
<p>
This section contains information for developers enhancing the Doxygen translator.
</p>
<H3><a name="Doxygen_translator_design"></a>39.5.1 Doxygen translator design</H3>
<H3><a name="Doxygen_translator_design">16.5.1 Doxygen translator design</a></H3>
<p>
@ -1651,7 +1665,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"></a>39.5.2 Debugging the Doxygen parser and translator</H3>
<H3><a name="Doxygen_debugging_commands">16.5.2 Debugging the Doxygen parser and translator</a></H3>
<p>
@ -1664,7 +1678,7 @@ detailed debug information printing.
-debug-doxygen-translator - Display Doxygen translator module debugging information
</pre></div>
<H3><a name="Doxygen_tests"></a>39.5.3 Tests</H3>
<H3><a name="Doxygen_tests">16.5.3 Tests</a></H3>
<p>
@ -1716,7 +1730,7 @@ Runtime tests in Python are just plain string comparisons of the __doc__
properties.
</p>
<H2><a name="Doxygen_language_extension"></a>39.6 Extending to other languages</H2>
<H2><a name="Doxygen_language_extension">16.6 Extending to other languages</a></H2>
<p>