diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 40 | ||||
| -rw-r--r-- | doc/config.doc | 20 | ||||
| -rw-r--r-- | doc/htmlcmds.doc | 2 | ||||
| -rw-r--r-- | doc/language.doc | 6 | ||||
| -rw-r--r-- | doc/markdown.doc | 7 | ||||
| -rw-r--r-- | doc/translator_report.txt | 22 |
6 files changed, 58 insertions, 39 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index d922efe..b19e38f 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -180,6 +180,7 @@ documentation: \refitem cmdverbatim \\verbatim \refitem cmdverbinclude \\verbinclude \refitem cmdversion \\version +\refitem cmdvhdlflow \\vhdlflow \refitem cmdwarning \\warning \refitem cmdweakgroup \\weakgroup \refitem cmdxmlonly \\xmlonly @@ -973,6 +974,15 @@ Structural indicators \sa section \ref cmdfn "\\fn", \ref cmdproperty "\\property", and \ref cmdtypedef "\\typedef". <hr> +\section cmdvhdlflow \\vhdlflow [(title for the flow chart)] + + \addindex \\vhdlflow + This is a VHDL specific command, which can be put in the documentation of a process to + produce a flow chart of the logic in the process. + Optionally a title for the flow chart can be given. + \note Currently the flow chart will only appear in the HTML output. + +<hr> \section cmdweakgroup \\weakgroup <name> [(title)] \addindex \\addtogroup Can be used exactly like \ref cmdaddtogroup "\\addtogroup", but has @@ -1061,7 +1071,7 @@ Section indicators for an example. <hr> -\section cmdcond \\cond [<section-label>] +\section cmdcond \\cond [(section-label)] \addindex \\cond Starts a conditional section that ends with a corresponding @@ -1073,7 +1083,8 @@ Section indicators The section between \\cond and \\endcond commands can be included by adding its section label to the \ref cfg_enabled_sections "ENABLED_SECTIONS" configuration option. If the section label is omitted, the section will - be excluded from processing unconditionally. + be excluded from processing unconditionally. The section label can be a logical expression + build of section names, round brackets, && (AND), || (OR) and ! (NOT). For conditional sections within a comment block one should use a \ref cmdif "\\if" ... \ref cmdendif "\\endif" block. @@ -1129,7 +1140,7 @@ contains \c TEST, or \c DEV \sa section \ref cmdcondnot "\\condnot" and section \ref cmdendcond "\\endcond". <hr> -\section cmdcondnot \\condnot <section-label> +\section cmdcondnot \\condnot [(section-label)] \addindex \\condnot Starts a conditional section that ends with a corresponding @@ -1140,7 +1151,8 @@ contains \c TEST, or \c DEV 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. + configuration option. The section label can be a logical expression + build of section names, round brackets, && (AND), || (OR) and ! (NOT). For conditional sections within a comment block one should use a \ref cmdif "\\if" ... \ref cmdendif "\\endif" block. @@ -1202,15 +1214,16 @@ contains \c TEST, or \c DEV \ref cmdendif "\\endif." <hr> -\section cmdelseif \\elseif <section-label> +\section cmdelseif \\elseif (section-label) \addindex \\elseif Starts a conditional documentation section if the previous section was not enabled. A conditional section is disabled by default. To enable it you must put the section-label after the \ref cfg_enabled_sections "ENABLED_SECTIONS" - tag in the configuration - file. Conditional blocks can be nested. A nested section is + tag in the configuration file. The section label can be a logical expression + build of section names, round brackets, && (AND), || (OR) and ! (NOT). + Conditional blocks can be nested. A nested section is only enabled if all enclosing sections are enabled as well. \sa sections \ref cmdendif "\\endif", \ref cmdifnot "\\ifnot", @@ -1249,15 +1262,16 @@ contains \c TEST, or \c DEV example. <hr> -\section cmdif \\if <section-label> +\section cmdif \\if (section-label) \addindex \\if Starts a conditional documentation section. The section ends with a matching \c \\endif command. A conditional section is disabled by default. To enable it you must put the section-label after the \ref cfg_enabled_sections "ENABLED_SECTIONS" - tag in the configuration - file. Conditional blocks can be nested. A nested section is + tag in the configuration file. The section label can be a logical expression + build of section names, round brackets, && (AND), || (OR) and ! (NOT). + Conditional blocks can be nested. A nested section is only enabled if all enclosing sections are enabled as well. \par Example: @@ -1309,15 +1323,15 @@ ALIASES = "english=\if english" \ \ref cmdelse "\\else", and \ref cmdelseif "\\elseif". <hr> -\section cmdifnot \\ifnot <section-label> +\section cmdifnot \\ifnot (section-label) \addindex \\ifnot Starts a conditional documentation section. The section ends with a matching \c \\endif command. This conditional section is enabled by default. To disable it you must put the section-label after the \ref cfg_enabled_sections "ENABLED_SECTIONS" - tag in the configuration - file. + tag in the configuration file. The section label can be a logical expression + build of section names, round brackets, && (AND), || (OR) and ! (NOT). \sa sections \ref cmdendif "\\endif", \ref cmdif "\\if", \ref cmdelse "\\else", and \ref cmdelseif "\\elseif". diff --git a/doc/config.doc b/doc/config.doc index 8dfb199..64456c7 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -208,6 +208,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_man_output MAN_OUTPUT \refitem cfg_markdown_support MARKDOWN_SUPPORT \refitem cfg_mathjax_extensions MATHJAX_EXTENSIONS +\refitem cfg_mathjax_format MATHJAX_FORMAT \refitem cfg_mathjax_relpath MATHJAX_RELPATH \refitem cfg_max_dot_graph_depth MAX_DOT_GRAPH_DEPTH \refitem cfg_max_initializer_lines MAX_INITIALIZER_LINES @@ -281,6 +282,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_uml_look UML_LOOK \refitem cfg_use_htags USE_HTAGS \refitem cfg_use_mathjax USE_MATHJAX +\refitem cfg_use_mdfile_as_mainpage USE_MDFILE_AS_MAINPAGE \refitem cfg_use_pdflatex USE_PDFLATEX \refitem cfg_verbatim_headers VERBATIM_HEADERS \refitem cfg_warn_format WARN_FORMAT @@ -1204,6 +1206,14 @@ AClass::ANamespace, ANamespace::*Test using `*.ext=` (so without naming a filter). This option only has effect when \c FILTER_SOURCE_FILES is enabled. +\anchor cfg_use_mdfile_as_mainpage +<dt>\c USE_MDFILE_AS_MAINPAGE <dd> + \addindex USE_MDFILE_AS_MAINPAGE +If the \c USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that +is part of the input, its contents will be placed on the main page (index.html). +This can be useful if you have a project on for instance GitHub and want reuse +the introduction page also for the doxygen output. + </dl> \section sourcebrowser_index Source browsing related options @@ -1867,6 +1877,16 @@ and does not have live searching capabilities. configure the path to it using the \ref cfg_mathjax_relpath "MATHJAX_RELPATH" option. +\anchor cfg_mathjax_format +<dt>\c MATHJAX_FORMAT <dd> + \addindex MATHJAX_FORMAT + When MathJax is enabled you can set the default output format to be used for + the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and + SVG. The default value is HTML-CSS, which is slower, but has the best + compatibility. See +<a href="http://docs.mathjax.org/en/latest/output.html">the MathJax site</a> +for more details. + \anchor cfg_mathjax_relpath <dt>\c MATHJAX_RELPATH <dd> \addindex MATHJAX_RELPATH diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index d4af0f9..db3c6f3 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -112,7 +112,7 @@ The special HTML character entities that are recognized by Doxygen: <ul> <li><tt>\©</tt> the copyright symbol -<li><tt>\&tm;</tt> the trade mark symbol +<li><tt>\™</tt> the trade mark symbol <li><tt>\®</tt> the registered trade mark symbol <li><tt>\<</tt> less-than symbol <li><tt>\></tt> greater-than symbol diff --git a/doc/language.doc b/doc/language.doc index 6052537..b1cdf4e 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.2), 39 languages +Currently (version 1.8.1.2), 39 languages are supported (sorted alphabetically): Afrikaans, Arabic, Armenian, Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, @@ -146,7 +146,7 @@ when the translator was updated. <td>German</td> <td>Peter Grotrian<br/>Jens Seidel</td> <td>Peter dot Grotrian at pdv-FS dot de<br/>jensseidel at users dot sf dot net</td> - <td>1.8.2</td> + <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Greek</td> @@ -351,7 +351,7 @@ when the translator was updated. French & David Martinet & {\tt\tiny contact at e-concept-applications dot fr} & 1.8.0 \\ ~ & Xavier Outhier & {\tt\tiny xouthier at yahoo dot fr} & ~ \\ \hline - German & Peter Grotrian & {\tt\tiny Peter dot Grotrian at pdv-FS dot de} & 1.8.2 \\ + German & Peter Grotrian & {\tt\tiny Peter dot Grotrian at pdv-FS dot de} & up-to-date \\ ~ & Jens Seidel & {\tt\tiny jensseidel at users dot sf dot net} & ~ \\ \hline Greek & Paul Gessos & {\tt\tiny gessos dot paul at yahoo dot gr} & up-to-date \\ diff --git a/doc/markdown.doc b/doc/markdown.doc index d0243dd..3799fbc 100644 --- a/doc/markdown.doc +++ b/doc/markdown.doc @@ -556,15 +556,16 @@ Example: 2. Item2 of list 2 With Markdown the actual numbers you use to mark the list have no -effect on the HTML output Markdown produces. I.e. it treats the -following as a list with 3 numbered items: +effect on the HTML output Markdown produces. I.e. standard Markdown treats the +following as one list with 3 numbered items: 1. Item1 1. Item2 1. Item3 Doxygen however requires that the numbers used as marks are in -strictly ascending order; an item with a equal or lower number than +strictly ascending order, so the above example would produce 3 lists +with one item. An item with a equal or lower number than the preceding item, will start a new list. For example: 1. Item1 of list 1 diff --git a/doc/translator_report.txt b/doc/translator_report.txt index a50ef27..b364de4 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -1,4 +1,4 @@ -(1.8.2) +(1.8.1.2) Doxygen supports the following 39 languages (sorted alphabetically): @@ -10,7 +10,7 @@ Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, SerbianCyrilic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian, and Vietnamese. -Of them, 7 translators are up-to-date, 32 translators are based on +Of them, 8 translators are up-to-date, 31 translators are based on some adapter class, and 2 are English based. ---------------------------------------------------------------------- @@ -23,6 +23,7 @@ still may be some details listed even for them: TranslatorDutch TranslatorEnglish TranslatorEsperanto + TranslatorGerman TranslatorGreek TranslatorSlovak TranslatorSpanish @@ -38,7 +39,6 @@ must be implemented to become up-to-date: Note: Change the base class to TranslatorAdapter_1_8_2. TranslatorItalian 1.8.2 7 methods to implement (2 %) - TranslatorGerman 1.8.2 7 methods to implement (2 %) TranslatorCroatian 1.8.2 7 methods to implement (2 %) TranslatorChinese 1.8.2 7 methods to implement (2 %) TranslatorPortuguese 1.8.0 14 methods to implement (5 %) @@ -440,22 +440,6 @@ TranslatorFrench (TranslatorAdapter_1_8_0) 14 methods to implement (5 %) virtual QCString trInstanceMethods() -TranslatorGerman (TranslatorAdapter_1_8_2) 7 methods to implement (2 %) ----------------- - - Implements 235 of the required methods (97 %). - - Missing methods (should be implemented): - - virtual QCString trClassMethods() - virtual QCString trProvidedByCategory() - virtual QCString trDesignOverview() - virtual QCString trMethodDocumentation() - virtual QCString trPanelSynchronisationTooltip(bool enable) - virtual QCString trExtendsClass() - virtual QCString trInstanceMethods() - - TranslatorHungarian (TranslatorAdapter_1_4_6) 50 methods to implement (20 %) ------------------- |