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

Add C++20 documentation chapter

Browse source 
[skip-ci]
This commit is contained in:
William S Fulton 2020-01-28 20:31:15 +00:00
commit 36e8d521de
35 changed files with 1045 additions and 1029 deletions
Download patch file Download diff file Expand all files Collapse all files

56
Doc/Manual/Doxygen.html
View file

@ -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,7 +61,7 @@ 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>
@ -77,7 +77,7 @@ 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>
@ -194,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>
@ -203,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>
@ -211,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>
@ -223,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:&lt;command-name&gt;</a></H4>
<H4><a name="Doxygen_alias">18.2.2.2 doxygen:alias:&lt;command-name&gt;</a></H4>
<p>
@ -270,7 +270,7 @@ wrappers of the C++ API.
</p>
<H4><a name="Doxygen_ignore">17.2.2.3 doxygen:ignore:&lt;command-name&gt;</a></H4>
<H4><a name="Doxygen_ignore">18.2.2.3 doxygen:ignore:&lt;command-name&gt;</a></H4>
<p>
@ -421,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>
@ -430,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>
@ -440,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>
@ -456,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>
@ -563,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>
@ -825,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>
@ -992,14 +992,14 @@ comment, the whole comment block is ignored:
<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>
@ -1010,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>
@ -1173,7 +1173,7 @@ docs</a>), you may want to use some tool like doxypy
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>
@ -1426,7 +1426,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>
@ -1542,14 +1542,14 @@ Here is the list of these tags:
</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>
@ -1571,7 +1571,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>
@ -1611,14 +1611,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>
@ -1644,7 +1644,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>
@ -1657,7 +1657,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>
@ -1709,7 +1709,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>