diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile | 1 | ||||
| -rw-r--r-- | doc/commands.doc | 42 | ||||
| -rw-r--r-- | doc/language.doc | 12 | ||||
| -rw-r--r-- | doc/maintainers.txt | 3 |
4 files changed, 51 insertions, 7 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile index 7af4228..f44f52e 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -48,3 +48,4 @@ PERL_PATH = /usr/local/bin/perl SEARCHENGINE = NO PDF_HYPERLINKS = YES USE_PDFLATEX = YES +STRIP_CODE_COMMENTS = NO diff --git a/doc/commands.doc b/doc/commands.doc index 1a6d8e5..bd9b543 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -56,12 +56,14 @@ documentation: \refitem cmddefgroup \\defgroup \refitem cmddeprecated \\deprecated \refitem cmddontinclude \\dontinclude +\refitem cmddot \\dot \refitem cmddotfile \\dotfile \refitem cmde \\e \refitem cmdelse \\else \refitem cmdelseif \\elseif \refitem cmdem \\em \refitem cmdendcode \\endcode +\refitem cmdenddot \\enddot \refitem cmdendhtmlonly \\endhtmlonly \refitem cmdendif \\endif \refitem cmdendlatexonly \\endlatexonly @@ -1509,6 +1511,40 @@ ALIASES = "english=\if english" \ relation will be broken and flagged as an error. <hr> +\section cmddot \dot + + \addindex \\dot + Starts a text fragment which should contain a valid description of a + dot graph. The text fragment ends with \ref cmdenddot "\\enddot". + Doxygen will pass the text on to dot and include the resulting + image (and image map) into the output. + The nodes of a graph can be made clickable by using the URL attribute. + By using the command \\ref inside the URL value you can conveniently + link to an item inside doxygen. Here is an example: +\code +/*! class B */ +class B {}; + +/*! class C */ +class C {}; + +/*! \mainpage + * + * Class relations expressed via an inline dot graph: + * \dot + * digraph example { + * node [shape=record, fontname=Helvetica, fontsize=10]; + * b [ label="class B" URL="\ref B"]; + * c [ label="class C" URL="\ref C"]; + * b -> c [ arrowhead="open", style="dashed" ]; + * } + * \enddot + * Note that the classes in the above graph are clickable + * (in the HTML output). + */ +\endcode + +<hr> \section cmddotfile \dotfile <file> ["caption"] \addindex \\dotfile @@ -1569,6 +1605,12 @@ ALIASES = "english=\if english" \ \sa section \ref cmdcode "\\code" <hr> +\section cmdenddot \enddot + + \addindex \\enddot + Ends a blocks that was started with \ref cmddot "\\dot". + +<hr> \section cmdendhtmlonly \endhtmlonly \addindex \\endhtmlonly diff --git a/doc/language.doc b/doc/language.doc index dd926ac..a6d8fad 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.3.3-20030904), 29 languages +Currently (version 1.3.3), 29 languages are supported (sorted alphabetically): Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, @@ -115,7 +115,7 @@ when the translator was updated. <TD>French</TD> <TD>Xavier Outhier</TD> <TD>xouthier@NOSPAM.yahoo.fr</TD> - <TD>1.3.3</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>German</TD> @@ -215,8 +215,8 @@ when the translator was updated. </TR> <TR BGCOLOR="#ffffff"> <TD>Swedish</TD> - <TD>XeT Erixon</TD> - <TD>xet@NOSPAM.hem.passagen.se</TD> + <TD>Mikael Hallin</TD> + <TD>mikaelhallin@NOSPAM.yahoo.se</TD> <TD>1.3.3</TD> </TR> <TR BGCOLOR="#ffffff"> @@ -258,7 +258,7 @@ when the translator was updated. \hline Finnish & Olli Korhonen & {\tt Olli.Korhonen@ccc.fi} & obsolete \\ \hline - French & Xavier Outhier & {\tt xouthier@yahoo.fr} & 1.3.3 \\ + French & Xavier Outhier & {\tt xouthier@yahoo.fr} & up-to-date \\ \hline German & Jens Seidel & {\tt jensseidel@users.sf.net} & 1.3.1 \\ \hline @@ -295,7 +295,7 @@ when the translator was updated. \hline Spanish & Francisco Oltra Thennet & {\tt foltra@puc.cl} & 1.3.3 \\ \hline - Swedish & XeT Erixon & {\tt xet@hem.passagen.se} & 1.3.3 \\ + Swedish & Mikael Hallin & {\tt mikaelhallin@yahoo.se} & 1.3.3 \\ \hline Ukrainian & Olexij Tkatchenko & {\tt olexij.tkatchenko@gmx.de} & 1.2.11 \\ \hline diff --git a/doc/maintainers.txt b/doc/maintainers.txt index 7171bd3..e865c44 100644 --- a/doc/maintainers.txt +++ b/doc/maintainers.txt @@ -85,7 +85,8 @@ Spanish Francisco Oltra Thennet: foltra@puc.cl Swedish -XeT Erixon: xet@hem.passagen.se +Mikael Hallin: mikaelhallin@yahoo.se Ukrainian Olexij Tkatchenko: olexij.tkatchenko@gmx.de + |