From de03970396e6f7edec359e2b71f3d2aa9d6a6237 Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Sat, 26 Dec 2015 16:14:50 +0100 Subject: Tweaked the htmlonly sections in the manual so it produces valid HTML output --- doc/changelog.doc | 2336 +++++++++++++++++++++++++++-------------------------- doc/commands.doc | 55 +- doc/diagrams.doc | 3 +- doc/docblocks.doc | 8 + doc/grouping.doc | 4 + doc/translator.py | 2 + 6 files changed, 1229 insertions(+), 1179 deletions(-) diff --git a/doc/changelog.doc b/doc/changelog.doc index a2c540a..09ccb21 100644 --- a/doc/changelog.doc +++ b/doc/changelog.doc @@ -6,6 +6,7 @@ \htmlonly (release date 27-06-2015) +

+

\endhtmlonly \subsection log_1_8_9_1 Release 1.8.9.1 \htmlonly (release date 04-01-2015) +

+

\endhtmlonly \subsection log_1_8_9 Release 1.8.9 \htmlonly (release date 25-12-2014) +

+

\endhtmlonly \subsection log_1_8_8 Release 1.8.8 \htmlonly (release date 21-08-2014) +

New features

+

\endhtmlonly \subsection log_1_8_7 Release 1.8.7 \htmlonly (release date 21-04-2014) +

+

\endhtmlonly \subsection log_1_8_6 Release 1.8.6 \htmlonly (release date 24-12-2013) +

Bug fixes

+

\endhtmlonly \subsection log_1_8_5 Release 1.8.5 \htmlonly (release date 23-08-2013) +

Changes

New features

Bug fixes

+

\endhtmlonly \subsection log_1_8_4 Release 1.8.4 \htmlonly (release date 19-05-2013) +

Changes

New features

Bug fixes

+

\endhtmlonly \subsection log_1_8_3_1 Release 1.8.3.1 \htmlonly (release date 20-01-2013) +

Changes

New features

Bug fixes

+

\endhtmlonly \subsection log_1_8_3 Release 1.8.3 \htmlonly (release date 26-12-2012) +

Changes

New features

Bug fixes

+

\endhtmlonly \subsection log_1_8_2 Release 1.8.2 \htmlonly (release date 11-08-2012) +

Changes

New features

  • Made several improvements to the way Objective-C categories and protocols are handled: + inherited by the class itself, including the "Implemented by" relation.
    • +
  • Added option HTML_EXTRA_STYLESHEET which allows adding an additional - stylesheet without completely replacing doxygen.css. + stylesheet without completely replacing doxygen.css.
  • Added option AUTOLINK_SUPPORT which can be used to enable/disable - autolinking globally. + autolinking globally.
  • Included language updates for Czech, Spanish, Greek, Slovak, and - Esparanto. + Esparanto.

    • Bug fixes

    +

    \endhtmlonly \subsection log_1_8_1_2 Release 1.8.1.2 \htmlonly (release date 12-07-2012) +

    Changes

    New features

    Bug fixes

    +

    \endhtmlonly \subsection log_1_8_1_1 Release 1.8.1.1 \htmlonly (release date 10-06-2012) +

    Changes

    New features

    Bug fixes

    +

    \endhtmlonly \subsection log_1_8_1 Release 1.8.1 \htmlonly (release date 19-05-2012) +

    Changes

    New features

    Bug fixes

    +

    \endhtmlonly \subsection log_1_8_0 Release 1.8.0 \htmlonly (release date 25-02-2012) +

    Changes

    New features

    Bug fixes

    +

    \endhtmlonly \section log_1_7 1.7 Series \htmlonly +

    Doxygen Release 1.7.6.1

    (release date 10-12-2011)

    Changes

    @@ -1784,26 +1816,26 @@ make sure you add the following:
  • Doxygen now reports its cache usage (for the symbol and the lookup cache) at the end of a run (if QUIET=NO), and recommends settings for SYMBOL_CACHE_SIZE and LOOKUP_CACHE_SIZE for your - project if either cache is too small. + project if either cache is too small.

    • New features

    Bug fixes

    Doxygen Release 1.7.6

    @@ -1812,105 +1844,105 @@ make sure you add the following:

    New features

    Bug fixes

    Doxygen Release 1.7.5.1

    (release date 21-08-2011)

    New features

    Bug fixes

    Doxygen Release 1.7.5

    @@ -1918,142 +1950,142 @@ make sure you add the following:

    Changes

    New features

    Bug fixes

    Doxygen Release 1.7.4

    @@ -2061,86 +2093,86 @@ make sure you add the following:

    Changes

    New features

    Bug fixes

    Doxygen Release 1.7.3

    @@ -2152,81 +2184,81 @@ make sure you add the following: Disabling the index (with DISABLE_INDEX) still shows the new header (you can still customize this using HTML_HEADER). This now works nicely in combination with GENERATE_TREEVIEW = YES and/or - SEARCH_ENGINE = YES. + SEARCH_ENGINE = YES.
  • Redesigned the treeview feature. Instead of using frames, the navigation tree is now loaded on each page dynamically. This allows bookmarking a page and always keeps the top menu visible. Also the current item is automatically highlighted in the tree. Also updated the icons in the treeview to match the overall look'n'feel. Note: if you now use a custom HTML header, please update it using - doxygen with the -w and the edit the default header. + doxygen with the -w and the edit the default header.

    • New features

    Bug fixes

    Doxygen Release 1.7.2

    @@ -2234,106 +2266,106 @@ make sure you add the following:

    Changes

    New features

    Bug fixes

    Doxygen Release 1.7.1

    @@ -2342,49 +2374,49 @@ make sure you add the following:

    New features

    Bug fixes

    @@ -2392,192 +2424,194 @@ make sure you add the following:

    (release date 15-06-2010)

    Changes

    New features

    Bug fixes

    +

    \endhtmlonly \section log_1_6 1.6 Series \htmlonly +

    Doxygen Release 1.6.3

    (release date 21-02-2010)

    New features

    Bug fixes

    @@ -2587,104 +2621,104 @@ make sure you add the following:

    Changes

    New features

    Bug fixes

    @@ -2694,16 +2728,16 @@ make sure you add the following:

    Doxygen Release 1.6.0

    (release date 20-08-2009)

    @@ -2713,83 +2747,81 @@ make sure you add the following: Javascript/DHTML based one. As a result the search feature no longer requires a HTTP server with PHP enabled to be usable. Searching is limited to symbols - though, but it is now possible to filter on symbol type. -
  • id 519886: Make the HTML output XHTML 1.0 compliant. + though, but it is now possible to filter on symbol type.
    • +
  • id 519886: Make the HTML output XHTML 1.0 compliant.
  • id 579950: Objective-C categories are now merged with their base - class, unless there is no base class. + class, unless there is no base class.
  • Member groups with the same header within the same scope are now - merged. This also works for Objective-C categories. + merged. This also works for Objective-C categories.
  • Changed the LaTeX style sheet such that more of the markup is - configurable. Please update your style sheet if you use a custom one. + configurable. Please update your style sheet if you use a custom one.
  • id 584844: Treat \details inside a brief description as a new paragraph - command. + command.
  • Split GENERATE_TREEVIEW into two separate options: - GENERATE_TREEVIEW and USE_INLINE_TREES. + GENERATE_TREEVIEW and USE_INLINE_TREES.
  • Removed the dependencies on libpng and libz, doxygen now generates - gifs again for internal class diagrams (like it did 7 years ago ;-) + gifs again for internal class diagrams (like it did 7 years ago ;-)

    • New features

    Bug fixes

    Doxygen Release 1.5 and earlier

    -

    -

    -

    +

    Go back to the main page. - +

    \endhtmlonly */ diff --git a/doc/commands.doc b/doc/commands.doc index df120a2..313e518 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -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

    \endhtmlonly +\htmlonly

    \endhtmlonly

    \htmlonly --- \endhtmlonly Structural indicators \htmlonly --- \endhtmlonly

    -\htmlonly
    \endhtmlonly +\htmlonly

    \endhtmlonly \section cmdaddtogroup \\addtogroup [(title)] \addindex \\addtogroup @@ -368,7 +368,7 @@ Structural indicators for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. \endlatexonly -

    +

    \section cmddef \\def \addindex \\def @@ -386,8 +386,7 @@ Structural indicators for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. \endlatexonly - -
    +

    \section cmddefgroup \\defgroup (group title) \addindex \\defgroup @@ -439,7 +438,7 @@ Structural indicators for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. \endlatexonly -
    +

    \section cmdexample \\example \addindex \\example @@ -476,7 +475,7 @@ Structural indicators \sa section \ref cmdinclude "\\include". -
    +

    \section cmdendinternal \\endinternal \addindex \\endinternal @@ -498,6 +497,7 @@ Structural indicators \htmlonly Click here for the corresponding HTML documentation that is generated by doxygen. +

    \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. -
    +

    \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". -
    +

    \section cmdheaderfile \\headerfile [] \addindex \\headerfile @@ -649,6 +649,7 @@ Structural indicators \htmlonly Click here for the corresponding HTML documentation that is generated by doxygen. +

    \endhtmlonly \latexonly See \hyperlink{extends_example}{Implements example} @@ -759,7 +760,7 @@ Structural indicators \ref cmdpublic "\\public", \ref cmdprotected "\\protected" and \ref cmdprivate "\\private". -
    +

    \section cmdname \\name [(header)] \addindex \\name @@ -827,7 +828,7 @@ Structural indicators for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. \endlatexonly -
    +

    \section cmdpackage \\package \addindex \\package @@ -868,7 +869,7 @@ Structural indicators \ref cmdsubsection "\\subsection", and section \ref cmdref "\\ref". -
    +

    \section cmdprivate \\private \addindex \\private @@ -1015,7 +1016,7 @@ Structural indicators for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. \endlatexonly -
    +

    \section cmdrelated \\related \addindex \\related @@ -1126,13 +1127,13 @@ Structural indicators
    -\htmlonly
    \endhtmlonly +\htmlonly

    \endhtmlonly

    \htmlonly --- \endhtmlonly Section indicators \htmlonly --- \endhtmlonly

    -\htmlonly
    \endhtmlonly +\htmlonly

    \endhtmlonly

    \section cmdattention \\attention { attention text } @@ -1170,7 +1171,7 @@ Section indicators for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. \endlatexonly -
    +

    \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 -
    +

    \section cmdparam \\param [(dir)] { parameter description } \addindex \\param @@ -1859,13 +1860,13 @@ void setPosition(double x,double y,double z,double t)
    -\htmlonly
    \endhtmlonly +\htmlonly

    \endhtmlonly

    \htmlonly --- \endhtmlonly Commands to create links \htmlonly --- \endhtmlonly

    -\htmlonly
    \endhtmlonly +\htmlonly

    \endhtmlonly

    \section cmdaddindex \\addindex (text) @@ -2084,13 +2085,13 @@ Make sure you have first read \ref intro "the introduction".
    -\htmlonly
    \endhtmlonly +\htmlonly

    \endhtmlonly

    \htmlonly --- \endhtmlonly Commands for displaying examples \htmlonly --- \endhtmlonly

    -\htmlonly
    \endhtmlonly +\htmlonly

    \endhtmlonly

    \section cmddontinclude \\dontinclude @@ -2135,7 +2136,7 @@ Commands for displaying examples \ref cmdskipline "\\skipline", \ref cmduntil "\\until", and \ref cmdinclude "\\include". -
    +

    \section cmdinclude \\include \addindex \\include @@ -2339,13 +2340,13 @@ Commands for displaying examples
    -\htmlonly
    \endhtmlonly +\htmlonly

    \endhtmlonly

    \htmlonly --- \endhtmlonly Commands for visual enhancements \htmlonly --- \endhtmlonly

    -\htmlonly
    \endhtmlonly +\htmlonly

    \endhtmlonly \section cmda \\a @@ -3321,13 +3322,13 @@ class Receiver writing three consecutuve dashes to the output instead of one m-dash character (---).

    -\htmlonly
    \endhtmlonly +\htmlonly

    \endhtmlonly

    \htmlonly --- \endhtmlonly Commands included for Qt compatibility \htmlonly --- \endhtmlonly

    -\htmlonly
    \endhtmlonly +\htmlonly

    \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 +

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

    \endhtmlonly */ diff --git a/doc/diagrams.doc b/doc/diagrams.doc index 2660b8e..49be5d6 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -138,6 +138,7 @@ 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). @@ -151,7 +152,7 @@ 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 7f91db5..735def6 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -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 +

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

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

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

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

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

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

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

    Click here for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly diff --git a/doc/grouping.doc b/doc/grouping.doc index 4357d27..64102e1 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -138,6 +138,7 @@ 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 @@ -195,6 +196,7 @@ documentation of the class. \include memgrp.cpp \htmlonly +

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

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

    \endhtmlonly */ diff --git a/doc/translator.py b/doc/translator.py index 69e7de8..1d470b4 100644 --- a/doc/translator.py +++ b/doc/translator.py @@ -1814,6 +1814,7 @@ class TrManager: # Define templates for HTML table parts of the documentation. htmlTableTpl = '''\ \\htmlonly +

    @@ -1832,6 +1833,7 @@ class TrManager:
    +

    \\endhtmlonly ''' htmlTableTpl = textwrap.dedent(htmlTableTpl) -- cgit v0.12