diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 35 | ||||
| -rw-r--r-- | doc/language.doc | 11 | ||||
| -rw-r--r-- | doc/maintainers.txt | 1 |
3 files changed, 42 insertions, 5 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index edd5804..972fe90 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -56,6 +56,7 @@ documentation: <li> \refitem cmdc \c <li> \refitem cmdclass \class <li> \refitem cmdcode \code +<li> \refitem cmdcopydoc \copydoc <li> \refitem cmddate \date <li> \refitem cmddef \def <li> \refitem cmddefgroup \defgroup @@ -1364,6 +1365,40 @@ ALIASES = "english=\if english" \ \sa section \ref cmdendcode "\\endcode", section \ref cmdverbatim "\\verbatim" <hr> +\subsection cmdcopydoc \copydoc <link-object> + + \addindex \copydoc + Copies a documentation block from the object specified by \<link-object\> + and pastes it at the location of the command. This command can be useful + to avoid cases where a documentation block would otherwise have to be + duplicated or it can be used to extend the documentation of an inherited + member. + + The link object can point to a member, a class, a namespace, a group, + a page, or a file (checked in that order). To copy the + documentation for a member of a class for instance one can put the + following in the documentation + +\verbatim + /*! @copydoc MyClass::myfunction() + * More documentation. + */ +\endverbatim + + if the member is overloaded, you should specify the argument types + explicitly (without spaces!), like in the following: + +\verbatim + /*! @copydoc MyClass::myfunction(type1,type2) */ +\endverbatim + + Qualified names are only needed if the context in which the documentation + block is found requires them. + + The copydoc command can be used recursively, but cycles in the copydoc + relation will be broken and flagged as an error. + +<hr> \subsection cmddotfile \dotfile <file> ["caption"] \addindex \dotfile diff --git a/doc/language.doc b/doc/language.doc index 242f8d3..22582b6 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.15-20020512), 26 languages +Currently (version 1.2.14-20020317), 26 languages are supported (sorted alphabetically): Brazilian Portuguese, Chinese, Chinesetraditional, Croatian, Czech, Danish, Dutch, English, Finnish, French, @@ -155,9 +155,9 @@ when the translator was updated. </TR> <TR BGCOLOR="#ffffff"> <TD>Polish</TD> - <TD>Grzegorz Kowal</TD> - <TD>g_kowal@NOSPAM.poczta.onet.pl</TD> - <TD>1.2.1</TD> + <TD>Piotr Kaminski<br>Grzegorz Kowal</TD> + <TD>Piotr.Kaminski@NOSPAM.ctm.gdynia.pl<br>g_kowal@NOSPAM.poczta.onet.pl</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Portuguese</TD> @@ -256,7 +256,8 @@ when the translator was updated. \hline Norwegian & Lars Erik Jordet & {\tt lej@circuitry.no} & 1.2.2 \\ \hline - Polish & Grzegorz Kowal & {\tt g\_kowal@poczta.onet.pl} & 1.2.1 \\ + Polish & Piotr Kaminski & {\tt Piotr.Kaminski@ctm.gdynia.pl} & up-to-date \\ + & Grzegorz Kowal & {\tt g\_kowal@poczta.onet.pl} & \\ \hline Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & up-to-date \\ \hline diff --git a/doc/maintainers.txt b/doc/maintainers.txt index 5f2ec0c..b729303 100644 --- a/doc/maintainers.txt +++ b/doc/maintainers.txt @@ -57,6 +57,7 @@ Norwegian Lars Erik Jordet: lej@circuitry.no Polish +Piotr Kaminski: Piotr.Kaminski@ctm.gdynia.pl Grzegorz Kowal: g_kowal@poczta.onet.pl Portuguese |