diff options
| author | Olly Betts <olly@survex.com> | 2015-03-16 14:28:00 +1300 |
|---|---|---|
| committer | Olly Betts <olly@survex.com> | 2015-03-16 14:28:00 +1300 |
| commit | a9f0d0fb4e54f18b2808407219234b9ee0f37fd9 (patch) | |
| tree | e4760cbb66d1343864e48878889a986e94988801 | |
| parent | 5e1faa9458e047020422470431555a2de790723c (diff) | |
| download | swig-a9f0d0fb4e54f18b2808407219234b9ee0f37fd9.tar.gz | |
Tag cleanup
Use lowercase tag names consistently and cleanup whitespace around tags.
| -rw-r--r-- | Doc/Manual/Doxygen.html | 82 |
1 files changed, 41 insertions, 41 deletions
diff --git a/Doc/Manual/Doxygen.html b/Doc/Manual/Doxygen.html index 769940f8d..b54db4074 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"></a>39 SWIG and Doxygen Translation</H1> +<h1><a name="Doxygen"></a>39 SWIG and Doxygen Translation</h1> <!-- INDEX --> <div class="sectiontoc"> <ul> @@ -50,15 +50,15 @@ 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"></a>39.1 Doxygen Translation Overview</h2> <p> The Doxygen Translation Module of SWIG is an ongoing effort from -a <A HREF ="http://code.google.com/soc/2008/">Google Summer of -Code</A> proposal from Summer 2008. It adds an extra layer of -functionality to SWIG, allowing automated translation of <A HREF= -"http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> formatted comments +a <a href="http://code.google.com/soc/2008/">Google Summer of +Code</a> proposal from Summer 2008. It adds an extra layer of +functionality to SWIG, allowing automated translation of <a href= +"http://www.stack.nl/~dimitri/doxygen/">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, but other @@ -68,27 +68,27 @@ extensions are to be added in time. <p> Questions about running SWIG are best answered in the <a href="SWIG.html#SWIG">SWIG Basics</a> chapter as well as the -target language modules. (For now, only <A href = "Java.html">Java</A> -and <A href = "Python.html">Python</A>). The behaviour of this +target language modules. (For now, only <a href="Java.html">Java</a> +and <a href="Python.html">Python</a>). The behaviour of this functionality is wildly unpredictable if the interface file is not proper to begin with! </p> -<H2><a name="Doxygen_file_preparation"></a>39.2 Preparations</H2> +<h2><a name="Doxygen_file_preparation"></a>39.2 Preparations</h2> <p> To make use of the comment translation system, your documentation -comments must be in properly formatted <A HREF= -"http://www.stack.nl/~dimitri/doxygen/">Doxygen.</A> They can be +comments must be in properly formatted <a href= +"http://www.stack.nl/~dimitri/doxygen/">Doxygen.</a> They can be present in your main interface file or any header file that it imports. It is advised that you are certain your comments compile properly with Doxygen before you try to translate them. Doxygen itself is a deeper 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.stack.nl/~dimitri/doxygen/docblocks.html"> Documenting the -code</A> for proper specifications for comment format. However, SWIG's +Doxygen's <a href= +"http://www.stack.nl/~dimitri/doxygen/docblocks.html">Documenting the +code</a> for proper specifications for comment format. However, SWIG's Doxygen parser will still point you most of errors and warnings found in comments (like unterminated strings or missing ending tags). </p> @@ -103,8 +103,8 @@ class Shape { <p> Currently, the whole subset of Doxygen comment styles is supported -(See <A HREF = "http://www.stack.nl/~dimitri/doxygen/docblocks.html"> -Documenting the code</A>). Here they are: +(See <a href="http://www.stack.nl/~dimitri/doxygen/docblocks.html"> +Documenting the code</a>). Here they are: <div class="code"><pre> /** @@ -122,8 +122,8 @@ Documenting the code</A>). Here they are: </p> <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 '<' added after comment-starting symbol, +like <i>/**<, /*!<, ///<, </i> or <i>//!<</i> will be treated as post-comment and will be assigned to the node before the comment. <br> @@ -200,7 +200,7 @@ Also, currently only the comments directly before or after the nodes are supported. Doxygen structural comments are stripped out and 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"></a>39.2.1 Enabling Doxygen Translation</h3> <p> Doxygen comments translation is disabled by default and needs to be explicitly @@ -208,7 +208,7 @@ 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"></a>39.2.2 Doxygen-specific %feature Directives</h3> <p> Translation of Doxygen comments is influenced by the following <a @@ -361,14 +361,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"></a>39.2.3 Additional Command Line Options</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"></a>39.3 Doxygen To Javadoc</h2> <p> @@ -377,7 +377,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"></a>39.3.1 Basic Example</h3> <p> @@ -486,7 +486,7 @@ directives</a>): </p> -<H3><a name="Doxygen_javadoc_tags"></a>39.3.2 Javadoc Tags</H3> +<h3><a name="Doxygen_javadoc_tags"></a>39.3.2 Javadoc Tags</h3> <p> @@ -740,7 +740,7 @@ Here is the list of all Doxygen tags and the description of how they are transla </table> </pre></div> -<H3><a name="Doxygen_unsupported_tags"></a>39.3.3 Unsupported tags</H3> +<h3><a name="Doxygen_unsupported_tags"></a>39.3.3 Unsupported tags</h3> <p> @@ -750,8 +750,8 @@ translation (or particular use, such as some linking and section tags) are suppressed with their content just printed out (if it has any sense, typically text content). If you are interested in more of the specifics of Javadoc, please -visit <A HREF="http://java.sun.com/j2se/javadoc/writingdoccomments/">How -to Write Doc Comments for the Javadoc Tool.</A> +visit <a href="http://java.sun.com/j2se/javadoc/writingdoccomments/">How +to Write Doc Comments for the Javadoc Tool.</a> <br> Here is the list of these tags: </p> @@ -972,14 +972,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"></a>39.3.4 Further Details</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"></a>39.4 Doxygen To Pydoc</h2> <p> @@ -990,7 +990,7 @@ Doxygen or Javadoc, so most of Doxygen commands are translated as English plain text pieces. </p> -<H3><a name="Doxygen_python_basic_example"></a>39.4.1 Basic Example</H3> +<h3><a name="Doxygen_python_basic_example"></a>39.4.1 Basic Example</h3> <p> @@ -1059,7 +1059,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="http://sphinx-doc.org/">Sphinx</a> documentation conventions. For example </p> <div class="code"><pre> /** @@ -1149,7 +1149,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"></a>39.4.2 Pydoc translator</h3> <p> @@ -1362,7 +1362,7 @@ Here is the list of all Doxygen tags and the description of how they are transla </table> </pre></div> -<H3><a name="Doxygen_python_unsupported_tags"></a>39.4.3 Unsupported tags</H3> +<h3><a name="Doxygen_python_unsupported_tags"></a>39.4.3 Unsupported tags</h3> <p> @@ -1544,20 +1544,20 @@ Here is the list of these tags: </table> </pre></div> -<H3><a name="Doxygen_python_further_details"></a>39.4.4 Further Details</H3> +<h3><a name="Doxygen_python_further_details"></a>39.4.4 Further Details</h3> <p> TO BE ADDED. </p> -<H2><a name="Doxygen_developer_details"></a>39.5 Developer Information</H2> +<h2><a name="Doxygen_developer_details"></a>39.5 Developer Information</h2> <p> </p> -<H3><a name="Doxygen_module_design"></a>39.5.1 Module Design</H3> +<h3><a name="Doxygen_module_design"></a>39.5.1 Module Design</h3> <p> @@ -1583,7 +1583,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 Doxygen parser and translator</H3> +<h3><a name="Doxygen_debugging_commands"></a>39.5.2 Debugging Doxygen parser and translator</h3> <p> @@ -1596,7 +1596,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"></a>39.5.3 Tests</h3> <p> @@ -1625,7 +1625,7 @@ check-python-test-suite'. To run them individually, type If the test fails, both expected and translated comments are printed to std out, but also written to files <i>expected.txt</i> -and <I>got.txt</I>. Since it is often difficult to find a single +and <i>got.txt</i>. Since it is often difficult to find a single character difference in several lines of text, we can use some diff tool, for example: <pre> @@ -1651,7 +1651,7 @@ Runtime tests in Python are just plain strings comparison with the use of __doc_ properties. </p> -<H2><a name="Doxygen_language_extension"></a>39.6 Extending to Other Languages</H2> +<h2><a name="Doxygen_language_extension"></a>39.6 Extending to Other Languages</h2> <p> @@ -1674,7 +1674,7 @@ The target language module hands the DoxygenTranslator the blob to translate, an */ </pre></div> <p> -<b> What is received back by java.cxx </b> +<b>What is received back by java.cxx</b> </p> <div class="targetlang"><pre> /** This is describing function Foo |