diff options
author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2012-09-30 13:51:29 (GMT) |
---|---|---|
committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2012-09-30 13:51:29 (GMT) |
commit | 9c9313827b29876de43ad5305fd7ac162013359c (patch) | |
tree | d18c06222e0f84d6077b586e5633053a8bc09da8 /doc | |
parent | 489cefdf7a2ce294a15cb12b866dce13f5664f12 (diff) | |
download | Doxygen-9c9313827b29876de43ad5305fd7ac162013359c.zip Doxygen-9c9313827b29876de43ad5305fd7ac162013359c.tar.gz Doxygen-9c9313827b29876de43ad5305fd7ac162013359c.tar.bz2 |
Release-1.8.2-20120930
Diffstat (limited to 'doc')
-rw-r--r-- | doc/commands.doc | 29 | ||||
-rw-r--r-- | doc/customize.doc | 11 | ||||
-rw-r--r-- | doc/faq.doc | 2 | ||||
-rw-r--r-- | doc/language.doc | 2 | ||||
-rw-r--r-- | doc/translator_report.txt | 2 |
5 files changed, 38 insertions, 8 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 66eabd9..d922efe 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -55,6 +55,7 @@ documentation: \refitem cmdclass \\class \refitem cmdcode \\code \refitem cmdcond \\cond +\refitem cmdcondnot \\condnot \refitem cmdcopybrief \\copybrief \refitem cmdcopydetails \\copydetails \refitem cmdcopydoc \\copydoc @@ -1125,7 +1126,29 @@ class Implementation : public Intf The output will be different depending on whether or not \c ENABLED_SECTIONS contains \c TEST, or \c DEV - \sa section \ref cmdendcond "\\endcond". + \sa section \ref cmdcondnot "\\condnot" and section \ref cmdendcond "\\endcond". + +<hr> +\section cmdcondnot \\condnot <section-label> + + \addindex \\condnot + Starts a conditional section that ends with a corresponding + \ref cmdendcond "\\endcond" command, which is typically found in + another comment block. The main purpose of this pair of + commands is to (conditionally) exclude part of a file from processing + (in older version of doxygen this could only be achieved using C preprocessor commands). + + The section between \\condnot and \\endcond commands can be excluded by + adding its section label to the \ref cfg_enabled_sections "ENABLED_SECTIONS" + configuration option. + + For conditional sections within a comment block one should + use a \ref cmdif "\\if" ... \ref cmdendif "\\endif" block. + + Conditional sections can be nested. In this case a nested section will only + be shown if it and its containing section are included. + + \sa section \ref cmdcond "\\cond" and section \ref cmdendcond "\\endcond". <hr> \section cmdcopyright \\copyright { copyright description } @@ -1197,9 +1220,9 @@ contains \c TEST, or \c DEV \section cmdendcond \\endcond \addindex \\endcond - Ends a conditional section that was started by \ref cmdcond "\\cond". + Ends a conditional section that was started by \ref cmdcond "\\cond" or \ref cmdcondnot "\\condnot". - \sa section \ref cmdcond "\\cond". + \sa section \ref cmdcond "\\cond" and section \ref cmdcondnot "\\condnot". <hr> \section cmdendif \\endif diff --git a/doc/customize.doc b/doc/customize.doc index 610f8f4..b035826 100644 --- a/doc/customize.doc +++ b/doc/customize.doc @@ -109,12 +109,19 @@ This will create 3 files: a HTML page. Also here special commands can be used. This file contain the link to www.doxygen.org and the body and html end tags. - customdoxygen.css is the default cascading style sheet - used by doxygen. + used by doxygen. It is recommended only to look into this file and overrule + some settings you like by putting them in a separate stylesheet and + referencing that extra file + via \ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET". You should edit these files and then reference them from the config file. - \ref cfg_html_header "HTML_HEADER" = \c header.html - \ref cfg_html_footer "HTML_FOOTER" = \c footer.html -- \ref cfg_html_stylesheet "HTML_STYLESHEET" = \c customdoxygen.css +- \ref cfg_html_stylesheet "HTML_STYLESHEET" = \c customdoxygen.css <b>←obsolete</b> + +\note it is not longer recommended to use HTML_STYLESHEET this way, +as it make it difficult to upgrade to a newer version of doxygen. Use +\ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET" instead. See the documentation of the \ref cfg_html_header "HTML_HEADER" tag for more information about the possible meta commands you can use inside diff --git a/doc/faq.doc b/doc/faq.doc index 0475aa7..cc8a9a4 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -80,7 +80,7 @@ document either the class or namespace. <li><b>How can I make doxygen ignore some code fragment?</b> The new and easiest way is to add one comment block -with a \ref cmdcond "\\cond" command at the start and one comment block +with a \ref cmdcond "\\cond" or \ref cmdcondnot "\\condnot" command at the start and one comment block with a \ref cmdendcond "\\endcond" command at the end of the piece of code that should be ignored. This should be within the same file of course. diff --git a/doc/language.doc b/doc/language.doc index 83a0bfa..6052537 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -23,7 +23,7 @@ text fragments, generated by doxygen, can be produced in languages other than English (the default). The output language is chosen through the configuration file (with default name and known as Doxyfile). -Currently (version 1.8.1.2), 39 languages +Currently (version 1.8.2), 39 languages are supported (sorted alphabetically): Afrikaans, Arabic, Armenian, Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, diff --git a/doc/translator_report.txt b/doc/translator_report.txt index 83f020a..a50ef27 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -1,4 +1,4 @@ -(1.8.1.2) +(1.8.2) Doxygen supports the following 39 languages (sorted alphabetically): |