diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 18 | ||||
| -rw-r--r-- | doc/config.doc | 18 | ||||
| -rw-r--r-- | doc/language.doc | 58 |
3 files changed, 60 insertions, 34 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 972fe90..ee52cbe 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -325,14 +325,21 @@ doxygen. Unrecognized commands are treated as normal text. \addindex \fn Indicates that a comment block contains documentation for a function - (either global or as a member of a class). This command is needed if a - comment block is \e not placed in front of the function declaration - or definition. If your comment block \e is in front of the function + (either global or as a member of a class). This command is \em only + needed if a comment block is \e not placed in front (or behind) + the function declaration or definition. + + If your comment block \e is in front of the function declaration or definition this command can (and to avoid redundancy should) be ommitted. - A full function declaration should be specified after the - \\fn command. The argument ends at the end of the line. + A full function declaration including arguments should be specified after the + \\fn command on a \e single line, since the argument ends at the end + of the line! + + \warning Do not use this command + if it is not absolutely needed, since it will lead to duplication of + information and thus to errors. \par Example: \verbinclude func.h @@ -341,6 +348,7 @@ doxygen. Unrecognized commands are treated as normal text. for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \sa section \ref cmdvar "\\var" and \ref cmdtypedef "\\typedef". <hr> diff --git a/doc/config.doc b/doc/config.doc index b0043c4..e469b57 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -73,6 +73,7 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_case_sense_names CASE_SENSE_NAMES <li> \refitem cfg_cgi_name CGI_NAME <li> \refitem cfg_cgi_url CGI_URL +<li> \refitem cfg_chm_file CHM_FILE <li> \refitem cfg_class_diagrams CLASS_DIAGRAMS <li> \refitem cfg_class_graph CLASS_GRAPH <li> \refitem cfg_collaboration_graph COLLABORATION_GRAPH @@ -122,6 +123,7 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_generate_treeview GENERATE_TREEVIEW <li> \refitem cfg_graphical_hierarchy GRAPHICAL_HIERARCHY <li> \refitem cfg_have_dot HAVE_DOT +<li> \refitem cfg_hhc_location HHC_LOCATION <li> \refitem cfg_hide_scope_names HIDE_SCOPE_NAMES <li> \refitem cfg_hide_undoc_classes HIDE_UNDOC_CLASSES <li> \refitem cfg_hide_undoc_members HIDE_UNDOC_MEMBERS @@ -864,6 +866,22 @@ followed by the descriptions of the tags grouped by category. (which basically renders \c doxysearch obsolete on Windows). The HTML workshop also contains a viewer for compressed HTML files. +\anchor cfg_chm_file +<dt>\c CHM_FILE <dd> + \addindex CHM_FILE + If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c CHM_FILE tag can + be used to specify the file name of the resulting .chm file. You + can add a path in front of the file if the result should not be + written to the html output dir. + +\anchor cfg_hhc_location +<dt>\c HHC_LOCATION <dd> + \addindex HHC_LOCATION + If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c HHC_LOCATION tag can + be used to specify the location (absolute path including file name) of + the HTML help compiler (hhc.exe). If non empty doxygen will try to run + the html help compiler on the generated index.hhp. + \anchor cfg_generate_chi <dt>\c GENERATE_CHI <dd> \addindex GENERATE_CHI diff --git a/doc/language.doc b/doc/language.doc index 700fef2..2c15c0f 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.16-20020616), 27 languages +Currently (version 1.2.14-20020317), 27 languages are supported (sorted alphabetically): Brazilian Portuguese, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French, @@ -55,7 +55,7 @@ when the translator was updated. <TD>Brazilian Portuguese</TD> <TD>Fabio "FJTC" Jun Takada Chino</TD> <TD>chino@NOSPAM.icmc.sc.usp.br</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Chinese</TD> @@ -67,19 +67,19 @@ when the translator was updated. <TD>Chinese Traditional</TD> <TD>Gary Lee</TD> <TD>garylee@NOSPAM.ecosine.com.tw</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Croatian</TD> <TD>Boris Bralo</TD> <TD>boris.bralo@NOSPAM.zg.tel.hr</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Czech</TD> <TD>Petr Přikryl</TD> <TD>prikrylp@NOSPAM.skil.cz</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Danish</TD> @@ -109,13 +109,13 @@ when the translator was updated. <TD>French</TD> <TD>Xavier Outhier</TD> <TD>xouthier@NOSPAM.yahoo.fr</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>German</TD> <TD>Jens Seidel<br>Jens Breitenstein</TD> <TD>jensseidel@NOSPAM.users.sf.net<br>Jens.Breitenstein@NOSPAM.tlc.de</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Greek</TD> @@ -133,13 +133,13 @@ when the translator was updated. <TD>Italian</TD> <TD>Alessandro Falappa<br>Ahmed Aldo Faisal</TD> <TD>alessandro@NOSPAM.falappa.net<br>aaf23@NOSPAM.cam.ac.uk</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Japanese</TD> <TD>Ryunosuke Sato<br>Kenji Nagamatsu</TD> <TD>puyo@NOSPAM.mint.freemail.ne.jp<br>naga@NOSPAM.joyful.club.ne.jp</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Korean</TD> @@ -157,31 +157,31 @@ when the translator was updated. <TD>Polish</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> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Portuguese</TD> <TD>Rui Godinho Lopes</TD> <TD>ruiglopes@NOSPAM.yahoo.com</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Romanian</TD> <TD>Alexandru Iosup</TD> <TD>aiosup@NOSPAM.yahoo.com</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Russian</TD> <TD>Alexandr Chelpanov</TD> <TD>cav@NOSPAM.cryptopro.ru</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Serbian</TD> <TD>Dejan Milosavljevic</TD> <TD>dmilos@NOSPAM.email.com</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Slovak</TD> @@ -193,7 +193,7 @@ when the translator was updated. <TD>Slovene</TD> <TD>Matjaz Ostroversnik</TD> <TD>matjaz.ostroversnik@NOSPAM.zrs-tk.si</TD> - <TD>up-to-date</TD> + <TD>1.2.16</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Spanish</TD> @@ -224,16 +224,16 @@ when the translator was updated. {\bf Language} & {\bf Maintainer} & {\bf Contact address} & {\bf Status} \\ \hline \hline - Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt chino@icmc.sc.usp.br} & up-to-date \\ + Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt chino@icmc.sc.usp.br} & 1.2.16 \\ \hline Chinese & Wei Liu & {\tt liuwei@asiainfo.com} & 1.2.13 \\ & Wang Weihan & {\tt wangweihan@capinfo.com.cn} & \\ \hline - Chinese Traditional & Gary Lee & {\tt garylee@ecosine.com.tw} & up-to-date \\ + Chinese Traditional & Gary Lee & {\tt garylee@ecosine.com.tw} & 1.2.16 \\ \hline - Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & up-to-date \\ + Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & 1.2.16 \\ \hline - Czech & Petr P\v{r}ikryl & {\tt prikrylp@skil.cz} & up-to-date \\ + Czech & Petr P\v{r}ikryl & {\tt prikrylp@skil.cz} & 1.2.16 \\ \hline Danish & Erik S\o{}e S\o{}rensen & {\tt erik@mail.nu} & 1.2.7 \\ \hline @@ -243,39 +243,39 @@ when the translator was updated. \hline Finnish & Olli Korhonen & {\tt Olli.Korhonen@ccc.fi} & obsolete \\ \hline - French & Xavier Outhier & {\tt xouthier@yahoo.fr} & up-to-date \\ + French & Xavier Outhier & {\tt xouthier@yahoo.fr} & 1.2.16 \\ \hline - German & Jens Seidel & {\tt jensseidel@users.sf.net} & up-to-date \\ + German & Jens Seidel & {\tt jensseidel@users.sf.net} & 1.2.16 \\ & Jens Breitenstein & {\tt Jens.Breitenstein@tlc.de} & \\ \hline Greek & Harry Kalogirou & {\tt harkal@rainbow.cs.unipi.gr} & 1.2.11 \\ \hline Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt foldvari@diatronltd.com} & 1.2.1 \\ \hline - Italian & Alessandro Falappa & {\tt alessandro@falappa.net} & up-to-date \\ + Italian & Alessandro Falappa & {\tt alessandro@falappa.net} & 1.2.16 \\ & Ahmed Aldo Faisal & {\tt aaf23@cam.ac.uk} & \\ \hline - Japanese & Ryunosuke Sato & {\tt puyo@mint.freemail.ne.jp} & up-to-date \\ + Japanese & Ryunosuke Sato & {\tt puyo@mint.freemail.ne.jp} & 1.2.16 \\ & Kenji Nagamatsu & {\tt naga@joyful.club.ne.jp} & \\ \hline Korean & Richard Kim & {\tt ryk@dspwiz.com} & 1.2.13 \\ \hline Norwegian & Lars Erik Jordet & {\tt lej@circuitry.no} & 1.2.2 \\ \hline - Polish & Piotr Kaminski & {\tt Piotr.Kaminski@ctm.gdynia.pl} & up-to-date \\ + Polish & Piotr Kaminski & {\tt Piotr.Kaminski@ctm.gdynia.pl} & 1.2.16 \\ & Grzegorz Kowal & {\tt g\_kowal@poczta.onet.pl} & \\ \hline - Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & up-to-date \\ + Portuguese & Rui Godinho Lopes & {\tt ruiglopes@yahoo.com} & 1.2.16 \\ \hline - Romanian & Alexandru Iosup & {\tt aiosup@yahoo.com} & up-to-date \\ + Romanian & Alexandru Iosup & {\tt aiosup@yahoo.com} & 1.2.16 \\ \hline - Russian & Alexandr Chelpanov & {\tt cav@cryptopro.ru} & up-to-date \\ + Russian & Alexandr Chelpanov & {\tt cav@cryptopro.ru} & 1.2.16 \\ \hline - Serbian & Dejan Milosavljevic & {\tt dmilos@email.com} & up-to-date \\ + Serbian & Dejan Milosavljevic & {\tt dmilos@email.com} & 1.2.16 \\ \hline Slovak & Stanislav Kudl\'{a}\v{c} & {\tt skudlac@pobox.sk} & 1.2.13 \\ \hline - Slovene & Matjaz Ostroversnik & {\tt matjaz.ostroversnik@zrs-tk.si} & up-to-date \\ + Slovene & Matjaz Ostroversnik & {\tt matjaz.ostroversnik@zrs-tk.si} & 1.2.16 \\ \hline Spanish & Francisco Oltra Thennet & {\tt foltra@puc.cl} & 1.2.7 \\ \hline |