From 565c21b260ca58c9d6b845ecc64f8c4aaa9a9a96 Mon Sep 17 00:00:00 2001 From: albert-github Date: Wed, 5 Dec 2018 19:50:14 +0100 Subject: 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) --- doc/CMakeLists.txt | 15 +- doc/changelog.doc | 628 ++++++++++++++++++++++++++--------------------------- doc/commands.doc | 2 - doc/diagrams.doc | 2 - doc/docblocks.doc | 10 +- doc/grouping.doc | 4 - 6 files changed, 328 insertions(+), 333 deletions(-) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index e940622..ff5ebc7 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -27,6 +27,17 @@ else() # doxygen project variables are unknown so look for doxygen in PATH find_package(Doxygen) endif() +# +# set output directory for some extra HTML files +# +file(STRINGS Doxyfile DOXY_HTML_OUTPUT REGEX "HTML_OUTPUT.*") +string(LENGTH "${DOXY_HTML_OUTPUT}" DOXY_HTML_OUTPUT_LEN) +if (${DOXY_HTML_OUTPUT_LEN}) + string(REGEX REPLACE ".*HTML_OUTPUT *= *\([^ ]*\)" "\\1" DOXY_HTML_OUTPUT ${DOXY_HTML_OUTPUT}) +else() + set(DOXY_HTML_OUTPUT "html") +endif() +set(PROJECT_BINARY_HTML_DIR ${PROJECT_BINARY_DIR}/${DOXY_HTML_OUTPUT}/) set(DOC_INSTALL_DIR "share/doc/packages/doxygen" CACHE STRING "Relative path where to install the documentation") set(DOC_FILES @@ -153,8 +164,8 @@ add_custom_target(doxygen_pdf WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/latex ) add_custom_target(docs - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/doc/doxygen_logo.gif ${PROJECT_BINARY_DIR}/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/doc/doxygen_logo_low.gif ${PROJECT_BINARY_DIR}/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/doc/doxygen_logo.gif ${PROJECT_BINARY_HTML_DIR} + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/doc/doxygen_logo_low.gif ${PROJECT_BINARY_HTML_DIR} DEPENDS ${PROJECT_BINARY_DIR}/man/doxygen.1 ${PROJECT_BINARY_DIR}/man/doxywizard.1 ${PROJECT_BINARY_DIR}/man/doxysearch.1 diff --git a/doc/changelog.doc b/doc/changelog.doc index ca00728..bcbfe44 100644 --- a/doc/changelog.doc +++ b/doc/changelog.doc @@ -8,123 +8,123 @@

\endhtmlonly @@ -135,60 +135,60 @@

\endhtmlonly @@ -199,156 +199,156 @@

\endhtmlonly diff --git a/doc/commands.doc b/doc/commands.doc index 20c94e1..c582955 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -574,7 +574,6 @@ Structural indicators \htmlonly Click here for the corresponding HTML documentation that is generated by doxygen. -

\endhtmlonly \latexonly See \hyperlink{extends_example}{Extends example} @@ -726,7 +725,6 @@ Structural indicators \htmlonly Click here for the corresponding HTML documentation that is generated by doxygen. -

\endhtmlonly \latexonly See \hyperlink{extends_example}{Implements example} diff --git a/doc/diagrams.doc b/doc/diagrams.doc index 49be5d6..a0b4285 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -138,7 +138,6 @@ that doxygen can generate: \include diagrams_e.h \htmlonly -

Click here for the corresponding HTML documentation that is generated by doxygen
(EXTRACT_ALL = YES is used here). @@ -152,7 +151,6 @@ for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. \endlatexonly \htmlonly -

Go to the next section or return to the index. \endhtmlonly 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 -

Click here 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 -

Click here 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 -

Click here 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 -

Click here 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 -

Click here 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 -

Click here 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 -

Click here 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 -

Click here for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly diff --git a/doc/grouping.doc b/doc/grouping.doc index 2c4ebe1..2a87704 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -138,7 +138,6 @@ in .c files without having to duplicate the hierarchy exactly. \include group.cpp \htmlonly -

Click here for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -196,7 +195,6 @@ documentation of the class. \include memgrp.cpp \htmlonly -

Click here for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -226,10 +224,8 @@ 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 -

Go to the next section or return to the index. -

\endhtmlonly */ -- cgit v0.12