summaryrefslogtreecommitdiffstats
path: root/doc/docblocks.doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2018-12-05 18:50:14 (GMT)
committeralbert-github <albert.tests@gmail.com>2018-12-05 18:50:14 (GMT)
commit565c21b260ca58c9d6b845ecc64f8c4aaa9a9a96 (patch)
treea0b58da9c2416db29519ce93f4804910e11ecb77 /doc/docblocks.doc
parent7bcd67f4affa7c3ce2ba6f652c893488952396a7 (diff)
downloadDoxygen-565c21b260ca58c9d6b845ecc64f8c4aaa9a9a96.zip
Doxygen-565c21b260ca58c9d6b845ecc64f8c4aaa9a9a96.tar.gz
Doxygen-565c21b260ca58c9d6b845ecc64f8c4aaa9a9a96.tar.bz2
Doxygen manual is not XHTML compliant
The doxygen manual is not XHTML compliant. In this, first, fix : - fixes the problems in the doc files (note that docblocks has a small extra problem, pull request for this is #6660) - determine output directory for HTML based on the doxyfile (for images). Note: Remaining problems with examples and old change log files (version 1.5 and earlier)
Diffstat (limited to 'doc/docblocks.doc')
-rw-r--r--doc/docblocks.doc10
1 files changed, 1 insertions, 9 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index a9cb05a..d4eab5d 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -259,7 +259,6 @@ 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_afterdoc___test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
@@ -280,7 +279,6 @@ 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_q_tstyle___test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
@@ -315,7 +313,6 @@ 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_javadoc___test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
@@ -396,7 +393,6 @@ 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
@@ -441,7 +437,6 @@ 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
@@ -462,7 +457,6 @@ 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
@@ -492,7 +486,6 @@ 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
@@ -557,7 +550,7 @@ All following comment lines and continuation lines will be added to this
block. The block ends with a line not starting with a \c # (hash sign).
A brief documentation can be added with \c ;#< (semicolon, hash and
-lower then sign). The brief documentation also ends at a line not starting
+less-than sign). The brief documentation also ends at a line not starting
with a \c # (hash sign).
Inside doxygen comment blocks all normal doxygen markings are supported.
@@ -606,7 +599,6 @@ 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