Permalink
Browse files

Tweaked the htmlonly sections in the manual so it produces valid HTML…

… output
  • Loading branch information...
Dimitri van Heesch
Dimitri van Heesch committed Dec 26, 2015
1 parent 165498d commit de03970396e6f7edec359e2b71f3d2aa9d6a6237
Showing with 1,229 additions and 1,179 deletions.
  1. +1,184 −1,152 doc/changelog.doc
  2. +29 −26 doc/commands.doc
  3. +2 −1 doc/diagrams.doc
  4. +8 −0 doc/docblocks.doc
  5. +4 −0 doc/grouping.doc
  6. +2 −0 doc/translator.py
View

Large diffs are not rendered by default.

Oops, something went wrong.
View
@@ -221,13 +221,13 @@ The following subsections provide a list of all commands that are recognized by
doxygen. Unrecognized commands are treated as normal text.
\htmlonly <center> \endhtmlonly
\htmlonly</p><center><p>\endhtmlonly
<h2>
\htmlonly --- \endhtmlonly
Structural indicators
\htmlonly --- \endhtmlonly
</h2>
\htmlonly </center> \endhtmlonly
\htmlonly</p></center><p>\endhtmlonly
\section cmdaddtogroup \\addtogroup <name> [(title)]
\addindex \\addtogroup
@@ -368,7 +368,7 @@ Structural indicators
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
<hr>
</p><hr>
\section cmddef \\def <name>
\addindex \\def
@@ -386,8 +386,7 @@ Structural indicators
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
<hr>
</p><hr>
\section cmddefgroup \\defgroup <name> (group title)
\addindex \\defgroup
@@ -439,7 +438,7 @@ Structural indicators
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
<hr>
</p><hr>
\section cmdexample \\example <file-name>
\addindex \\example
@@ -476,7 +475,7 @@ Structural indicators
\sa section \ref cmdinclude "\\include".
<hr>
</p><hr>
\section cmdendinternal \\endinternal
\addindex \\endinternal
@@ -498,6 +497,7 @@ Structural indicators
\htmlonly
Click <a href="examples/manual/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
</p>
\endhtmlonly
\latexonly
See \hyperlink{extends_example}{Extends example}
@@ -535,7 +535,7 @@ Structural indicators
\note In the above example \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF"
has been set to \c YES in the configuration file.
<hr>
</p><hr>
\section cmdfn \\fn (function declaration)
\addindex \\fn
@@ -573,7 +573,7 @@ Structural indicators
\sa sections \ref cmdvar "\\var", \ref cmdproperty "\\property", and
\ref cmdtypedef "\\typedef".
<hr>
</p><hr>
\section cmdheaderfile \\headerfile <header-file> [<header-name>]
\addindex \\headerfile
@@ -649,6 +649,7 @@ Structural indicators
\htmlonly
Click <a href="examples/manual/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
</p>
\endhtmlonly
\latexonly
See \hyperlink{extends_example}{Implements example}
@@ -759,7 +760,7 @@ Structural indicators
\ref cmdpublic "\\public", \ref cmdprotected "\\protected" and
\ref cmdprivate "\\private".
<hr>
</p><hr>
\section cmdname \\name [(header)]
\addindex \\name
@@ -827,7 +828,7 @@ Structural indicators
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
<hr>
</p><hr>
\section cmdpackage \\package <name>
\addindex \\package
@@ -868,7 +869,7 @@ Structural indicators
\ref cmdsubsection "\\subsection", and section
\ref cmdref "\\ref".
<hr>
</p><hr>
\section cmdprivate \\private
\addindex \\private
@@ -1015,7 +1016,7 @@ Structural indicators
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
<hr>
</p><hr>
\section cmdrelated \\related <name>
\addindex \\related
@@ -1126,13 +1127,13 @@ Structural indicators
<hr>
\htmlonly <center> \endhtmlonly
\htmlonly</p><center><p>\endhtmlonly
<h2>
\htmlonly --- \endhtmlonly
Section indicators
\htmlonly --- \endhtmlonly
</h2>
\htmlonly </center>\endhtmlonly
\htmlonly</p></center><p>\endhtmlonly
<hr>
\section cmdattention \\attention { attention text }
@@ -1170,7 +1171,7 @@ Section indicators
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
<hr>
</p><hr>
\section cmdauthors \\authors { list of authors }
\addindex \\authors
@@ -1517,7 +1518,7 @@ ALIASES = "english=\if english" \
for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
<hr>
</p><hr>
\section cmdparam \\param [(dir)] <parameter-name> { parameter description }
\addindex \\param
@@ -1859,13 +1860,13 @@ void setPosition(double x,double y,double z,double t)
<hr>
\htmlonly <center> \endhtmlonly
\htmlonly</p><center><p>\endhtmlonly
<h2>
\htmlonly --- \endhtmlonly
Commands to create links
\htmlonly --- \endhtmlonly
</h2>
\htmlonly </center>\endhtmlonly
\htmlonly</p></center><p>\endhtmlonly
<hr>
\section cmdaddindex \\addindex (text)
@@ -2084,13 +2085,13 @@ Make sure you have first read \ref intro "the introduction".
<hr>
\htmlonly <center> \endhtmlonly
\htmlonly</p><center><p>\endhtmlonly
<h2>
\htmlonly --- \endhtmlonly
Commands for displaying examples
\htmlonly --- \endhtmlonly
</h2>
\htmlonly </center>\endhtmlonly
\htmlonly</p></center><p>\endhtmlonly
<hr>
\section cmddontinclude \\dontinclude <file-name>
@@ -2135,7 +2136,7 @@ Commands for displaying examples
\ref cmdskipline "\\skipline", \ref cmduntil "\\until", and
\ref cmdinclude "\\include".
<hr>
</p><hr>
\section cmdinclude \\include <file-name>
\addindex \\include
@@ -2339,13 +2340,13 @@ Commands for displaying examples
<hr>
\htmlonly <center> \endhtmlonly
\htmlonly</p><center><p>\endhtmlonly
<h2>
\htmlonly --- \endhtmlonly
Commands for visual enhancements
\htmlonly --- \endhtmlonly
</h2>
\htmlonly </center>\endhtmlonly
\htmlonly</p></center><p>\endhtmlonly
\section cmda \\a <word>
@@ -3321,13 +3322,13 @@ class Receiver
writing three consecutuve dashes to the output instead of one m-dash character (---).
<hr>
\htmlonly <center> \endhtmlonly
\htmlonly</p><center><p>\endhtmlonly
<h2>
\htmlonly --- \endhtmlonly
Commands included for Qt compatibility
\htmlonly --- \endhtmlonly
</h2>
\htmlonly </center>\endhtmlonly
\htmlonly</p></center><p>\endhtmlonly
The following commands are supported to remain compatible to the Qt class
browser generator. Do \e not use these commands in your own documentation.
@@ -3346,8 +3347,10 @@ browser generator. Do \e not use these commands in your own documentation.
\htmlonly
</p>
Go to the <a href="htmlcmds.html">next</a> section or return to the
<a href="index.html">index</a>.
<p>
\endhtmlonly
*/
View
@@ -138,6 +138,7 @@ that doxygen can generate:
\include diagrams_e.h
\htmlonly
</p>
Click <a href="examples/diagrams/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen<br/>
(<code>EXTRACT_ALL</code> = <code>YES</code> is used here).
@@ -151,7 +152,7 @@ for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
\endlatexonly
\htmlonly
<br><br>
<br/><br/>
Go to the <a href="preprocessing.html">next</a> section or return to the
<a href="index.html">index</a>.
\endhtmlonly
View
@@ -259,6 +259,7 @@ located in front of the block instead of after the block.
Here is an example of the use of these comment blocks:
\include afterdoc.h
\htmlonly
</p>
Click <a href="examples/afterdoc/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
@@ -279,6 +280,7 @@ Here is an example of the use of these comment blocks:
Here is an example of a documented piece of C++ code using the Qt style:
\include qtstyle.cpp
\htmlonly
</p>
Click <a href="examples/qtstyle/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
@@ -313,6 +315,7 @@ Here is the same piece of code as shown above, this time documented using the
JavaDoc style and \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" set to YES:
\include jdstyle.cpp
\htmlonly
</p>
Click <a href="examples/jdstyle/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
@@ -393,6 +396,7 @@ Here is an example of a C header named \c structcmd.h that is documented
using structural commands:
\include structcmd.h
\htmlonly
</p>
Click <a href="examples/structcmd/html/structcmd_8h.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
@@ -437,6 +441,7 @@ and assume they have to be represented in a preformatted way.
\include docstring.py
\htmlonly
</p>
Click <a href="examples/docstring/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
@@ -457,6 +462,7 @@ Here is the same example again but now using doxygen style comments:
\include pyexample.py
\htmlonly
</p>
Click <a href="examples/pyexample/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
@@ -486,6 +492,7 @@ Here is an example VHDL file with doxygen comments:
\include mux.vhdl
\htmlonly
</p>
Click <a href="examples/mux/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
@@ -599,6 +606,7 @@ Following is an example using doxygen style comments:
\include tclexample.tcl
\htmlonly
</p>
Click <a href="examples/tclexample/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
View
@@ -138,6 +138,7 @@ in .c files without having to duplicate the hierarchy exactly.
\include group.cpp
\htmlonly
</p>
Click <a href="examples/group/html/modules.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
\endhtmlonly
@@ -195,6 +196,7 @@ documentation of the class.
\include memgrp.cpp
\htmlonly
</p>
Click <a href="examples/memgrp/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by Doxygen.
\endhtmlonly
@@ -224,8 +226,10 @@ two groups GA and GB, where GB is part of GA, page A is put in group GA,
and page B is put in group GB.
\htmlonly
</p>
Go to the <a href="formulas.html">next</a> section or return to the
<a href="index.html">index</a>.
<p>
\endhtmlonly
*/
View
@@ -1814,6 +1814,7 @@ def generateLanguageDoc(self):
# Define templates for HTML table parts of the documentation.
htmlTableTpl = '''\
\\htmlonly
</p>
<table align="center" cellspacing="0" cellpadding="0" border="0">
<tr bgcolor="#000000">
<td>
@@ -1832,6 +1833,7 @@ def generateLanguageDoc(self):
</td>
</tr>
</table>
<p>
\\endhtmlonly
'''
htmlTableTpl = textwrap.dedent(htmlTableTpl)

0 comments on commit de03970

Please sign in to comment.