diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 47 | ||||
| -rw-r--r-- | doc/config.doc | 8 | ||||
| -rw-r--r-- | doc/language.doc | 11 | ||||
| -rw-r--r-- | doc/maintainers.txt | 1 | ||||
| -rw-r--r-- | doc/preprocessing.doc | 11 |
5 files changed, 69 insertions, 9 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index d9cf37f..ee2eb3b 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -61,6 +61,7 @@ documentation: <li> \refitem cmddefgroup \defgroup <li> \refitem cmddeprecated \deprecated <li> \refitem cmddontinclude \dontinclude +<li> \refitem cmddotfile \dotfile <li> \refitem cmde \e <li> \refitem cmdelse \else <li> \refitem cmdelseif \elseif @@ -758,6 +759,32 @@ Public/Protected/Private/... section. */ \endverbatim + You can also use conditional commands inside aliases. To + document a class in two languages you could for instance use: + +\par Example 2: +\verbatim +/*! \english + * This is English. + * \endenglish + * \dutch + * Dit is Nederlands. + * \enddutch + */ +class Example +{ +}; +\endverbatim + <p>Where the following aliases are defined in the configuration file:<p> +\verbatim +ALIASES = "english=\if english" \ + "endenglish=\endif" \ + "dutch=\if dutch" \ + "enddutch=\endif" +\endverbatim + + and \c ENABLED_SECTIONS can be used to enable either \c english or \c dutch. + \sa sections \ref cmdendif "\\endif", \ref cmdifnot "\\ifnot", \ref cmdelse "\\else", and \ref cmdelseif "\\elseif". @@ -1332,6 +1359,24 @@ Public/Protected/Private/... section. \sa section \ref cmdendcode "\\endcode", section \ref cmdverbatim "\\verbatim" <hr> +\subsection cmddotfile \dotfile <file> ["caption"] + + \addindex \dotfile + Inserts an image generated by dot from \<file\> into the documentation. + + The first argument specifies the file name of the image. + doxygen will look for files in the paths (or files) that you specified + after the \ref cfg_dotfile_dirs "DOTFILE_DIRS" tag. + If the dot file is found it will be used as an input file to the dot tool. + The resulting image will be put into the correct output directory. + If the dot file name contains spaces you'll have to put quotes (") around it. + + The second argument is optional and can be used to specify the caption + that is displayed below the image. This argument has to be specified + between quotes even if it does not contain any spaces. The quotes are + stripped before the caption is displayed. + +<hr> \subsection cmde \e <word> \addindex \e @@ -1443,7 +1488,7 @@ Public/Protected/Private/... section. \ref cmdlatexonly "\\latexonly". <hr> -\subsection cmdimage \image <format> <file> ["<caption>"] [<sizeindication>=<size>] +\subsection cmdimage \image <format> <file> ["caption"] [<sizeindication>=<size>] \addindex \image Inserts an image into the documentation. This command is format diff --git a/doc/config.doc b/doc/config.doc index 4d5b92f..dbb0e53 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -84,6 +84,7 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_doc_abspath DOC_ABSPATH <li> \refitem cfg_doc_url DOC_URL <li> \refitem cfg_dot_path DOT_PATH +<li> \refitem cfg_dotfile_dirs DOTFILE_DIRS <li> \refitem cfg_enable_preprocessing ENABLE_PREPROCESSING <li> \refitem cfg_enum_values_per_line ENUM_VALUES_PER_LINE <li> \refitem cfg_enabled_sections ENABLED_SECTIONS @@ -1184,6 +1185,13 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> This tag can be used to specify the path where the dot tool can be found. If left blank, it is assumed the dot tool can be found on the path. +\anchor cfg_dotfile_dirs +<dt>\c DOTFILE_DIRS <dd> + \addindex DOTFILE_DIRS + This tag can be used to specify one or more directories that + contain dot files that are included in the documentation (see the + \\dotfile command). + \anchor cfg_max_dot_graph_height <dt>\c MAX_DOT_GRAPH_HEIGHT <dd> \addindex MAX_DOT_GRAPH_HEIGHT diff --git a/doc/language.doc b/doc/language.doc index daf3178..74f75b4 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -25,7 +25,7 @@ Doxygen has built-in support for multiple languages. This means that the text fragments that doxygen generates can be produced in languages other than English (the default) at configuration time. -Currently (version 1.2.8-20010726), 24 languages +Currently (version 1.2.9-20010812), 24 languages are supported (sorted alphabetically): Brazilian Portuguese, Chinese, Croatian, Czech, Danish, Dutch, English, Finnish, French, German, @@ -70,8 +70,8 @@ when the translator was updated. </TR> <TR BGCOLOR="#ffffff"> <TD>Czech</TD> - <TD>Petr Přikryl<br>Vlastimil Havran</TD> - <TD>prikrylp@NOSPAM.skil.cz<br>havran@NOSPAM.fel.cvut.cz</TD> + <TD>Petr Přikryl</TD> + <TD>prikrylp@NOSPAM.skil.cz</TD> <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> @@ -120,7 +120,7 @@ when the translator was updated. <TD>Italian</TD> <TD>Ahmed Aldo Faisal<br>Alessandro Falappa</TD> <TD>aaf23@NOSPAM.cam.ac.uk<br>a.falappa@NOSPAM.flashnet.it</TD> - <TD>1.2.7</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Japanese</TD> @@ -212,7 +212,6 @@ when the translator was updated. Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & up-to-date \\ \hline Czech & Petr P\v{r}ikryl & {\tt prikrylp@skil.cz} & up-to-date \\ - & Vlastimil Havran & {\tt havran@fel.cvut.cz} & \\ \hline Danish & Erik S\o{}e S\o{}rensen & {\tt erik@mail.nu} & 1.2.7 \\ \hline @@ -229,7 +228,7 @@ when the translator was updated. \hline Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt foldvari@diatronltd.com} & 1.2.1 \\ \hline - Italian & Ahmed Aldo Faisal & {\tt aaf23@cam.ac.uk} & 1.2.7 \\ + Italian & Ahmed Aldo Faisal & {\tt aaf23@cam.ac.uk} & up-to-date \\ & Alessandro Falappa & {\tt a.falappa@flashnet.it} & \\ \hline Japanese & Kenji Nagamatsu & {\tt naga@joyful.club.ne.jp} & 1.2.5 \\ diff --git a/doc/maintainers.txt b/doc/maintainers.txt index 5d654e0..646f6c1 100644 --- a/doc/maintainers.txt +++ b/doc/maintainers.txt @@ -12,7 +12,6 @@ Boris Bralo: boris.bralo@zg.tel.hr Czech Petr Přikryl: prikrylp@skil.cz -Vlastimil Havran: havran@fel.cvut.cz Danish Erik Søe Sørensen: erik@mail.nu diff --git a/doc/preprocessing.doc b/doc/preprocessing.doc index 524f7c5..1be3ecd 100644 --- a/doc/preprocessing.doc +++ b/doc/preprocessing.doc @@ -202,7 +202,16 @@ PREDEFINED = "DECLARE_INTERFACE(name)=class name" \ "ASSERT_VALID(x)=assert(x)" \ "TRACE0(x)=printf(x)" \ "OS_ERR(A,B)={ #A, B }" \ - __cplusplus + __cplusplus \ + "DECLARE_OLECREATE(class)= " \ + "BEGIN_DISPATCH_MAP(class1, class2)= " \ + "BEGIN_INTERFACE_MAP(class1, class2)= " \ + "INTERFACE_PART(class, id, name)= " \ + "END_INTERFACE_MAP()=" \ + "DISP_FUNCTION(class, name, function, result, id)=" \ + "END_DISPATCH_MAP()=" \ + "IMPLEMENT_OLECREATE2(class, name, id1, id2, id3, id4,\ + id5, id6, id7, id8, id9, id10, id11)=" \endverbatim As you can see doxygen's preprocessor is quite powerful, but if you want |