diff options
Diffstat (limited to 'Doc/Manual/Doxygen.html')
| -rw-r--r-- | Doc/Manual/Doxygen.html | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/Doc/Manual/Doxygen.html b/Doc/Manual/Doxygen.html index b14b05ba3..8a847bb7e 100644 --- a/Doc/Manual/Doxygen.html +++ b/Doc/Manual/Doxygen.html @@ -63,13 +63,13 @@ supported. <p> The Doxygen Translation module of SWIG adds an extra layer of functionality to SWIG, allowing automated translation of <a href= -"http://www.stack.nl/~dimitri/doxygen/">Doxygen</a> formatted comments +"http://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. Other extensions could be added at a later date. The Doxygen Translation module originally started as -a <a href="http://code.google.com/soc/2008/">Google Summer of +a <a href="https://developers.google.com/open-source/gsoc/2008/">Google Summer of Code</a> proposal from Summer 2008. </p> @@ -79,14 +79,14 @@ Code</a> proposal from Summer 2008. <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> Doxygen comments can be +"http://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.stack.nl/~dimitri/doxygen/docblocks.html"> Documenting the +"http://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). @@ -94,7 +94,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.stack.nl/~dimitri/doxygen/docblocks.html"> +(See <a href="http://www.doxygen.nl/manual/docblocks.html"> Documenting the code</a>). Here they are: </p> @@ -293,7 +293,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.stack.nl/~dimitri/doxygen/manual/commands.html">Doxygen documentation</a>, +As explained in <a href="http://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 @@ -818,7 +818,7 @@ Here is the list of all Doxygen tags and the description of how they are transla <p> Doxygen has a wealth of tags such as @latexonly that have no equivalent in Javadoc (all supported tags are listed in -<a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html">Javadoc documentation</a>). +<a href="https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html">Javadoc documentation</a>). As a result several tags have no translation or particular use, such as some linking and section tags. These are suppressed with their content just printed out (if the tag has any @@ -1223,9 +1223,9 @@ 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.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks">Doxygen +(see <a href="http://www.doxygen.nl/manual/docblocks.html#pythonblocks">Doxygen docs</a>), you may want to use some tool like doxypy -(<a href="http://code.foosel.org/doxypy">http://code.foosel.org/doxypy</a>) +(<a href="https://pypi.org/project/doxypy/">doxypy</a>) to do the work. </p> |