diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 4 | ||||
| -rw-r--r-- | doc/config.doc | 25 | ||||
| -rw-r--r-- | doc/index.doc | 3 | ||||
| -rw-r--r-- | doc/language.doc | 14 | ||||
| -rw-r--r-- | doc/starting.doc | 7 |
5 files changed, 41 insertions, 12 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 14fd61f..e478a3e 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -1763,7 +1763,7 @@ ALIASES = "english=\if english" \ to documented entities. <hr> -\section cmdlt \\< +\section cmdlt \< \addindex \\\< This command writes the \< character to the HTML and @@ -1771,7 +1771,7 @@ ALIASES = "english=\if english" \ character has to be escaped because it has a special meaning in HTML. <hr> -\section cmdgt \\> +\section cmdgt \> \addindex \\\> This command writes the \> character to the HTML and diff --git a/doc/config.doc b/doc/config.doc index 2dbd644..e704dd1 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -146,6 +146,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_latex_batchmode LATEX_BATCHMODE \refitem cfg_latex_cmd_name LATEX_CMD_NAME \refitem cfg_latex_header LATEX_HEADER +\refitem cfg_latex_hide_indices LATEX_HIDE_INDICES \refitem cfg_latex_output LATEX_OUTPUT \refitem cfg_macro_expansion MACRO_EXPANSION \refitem cfg_makeindex_cmd_name MAKEINDEX_CMD_NAME @@ -193,6 +194,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_template_relations TEMPLATE_RELATIONS \refitem cfg_toc_expand TOC_EXPAND \refitem cfg_treeview_width TREEVIEW_WIDTH +\refitem cfg_use_windows_encoding USE_WINDOWS_ENCODING \refitem cfg_verbatim_headers VERBATIM_HEADERS \refitem cfg_warn_format WARN_FORMAT \refitem cfg_warn_if_doc_error WARN_IF_DOC_ERROR @@ -240,6 +242,17 @@ followed by the descriptions of the tags grouped by category. German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish and Swedish. +\anchor cfg_use_windows_encoding +<dt>\c USE_WINDOWS_ENCODING <dd> + \addindex USE_WINDOWS_ENCODING + This tag can be used to specify the encoding used in the generated output. + The encoding is not always determined by the language that is chosen, + but also whether or not the output is meant for Windows or non-Windows users. + In case there is a difference, setting the \c USE_WINDOWS_ENCODING tag to \c YES + forces the Windows enconding, (this is the default for the Windows binary), + whereas setting the tag to \c NO uses a Unix-style encoding (the default for the + all platforms other than Windows). + \anchor cfg_extract_all <dt>\c EXTRACT_ALL <dd> \addindex EXTRACT_ALL @@ -953,8 +966,8 @@ function's detailed documentation block. If the \c GENERATE_TREEVIEW tag is set to YES, a side pannel will be generated containing a tree-like index structure (just like the one that is generated for HTML Help). For this to work a browser that supports - JavaScript and frames is required (for instance Netscape 4.0+ - or Internet explorer 4.0+). + JavaScript and frames is required (for instance Mozilla 1.0+, Netscape 6.0+ + or Internet explorer 5.0+ or Konqueror). \anchor cfg_treeview_width <dt>\c TREEVIEW_WIDTH <dd> @@ -1077,6 +1090,14 @@ EXTRA_PACKAGES = times asking the user for help. This option is also used when generating formulas in HTML. +\anchor cfg_latex_hide_indices +<dt>\c LATEX_HIDE_INDICES <dd> + \addindex LATEX_HIDE_INDICES + + If \c LATEX_HIDE_INDICES is set to \c YES then doxygen will not + include the index chapters (such as File Index, Compound Index, etc.) + in the output. + </dl> \section rtf_output RTF related options \anchor cfg_generate_rtf diff --git a/doc/index.doc b/doc/index.doc index 19b305e..97d5d5f 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -183,7 +183,8 @@ Thanks go to: Roddy, Paul Schwartz, Charles Duffy, Vadym Voznyuk, Philip Walton, Dwight Browne, Andreas Fredriksson, Karel Lindveld, Ivan Lee, Albert Vernon, Adam McKee, Vijapurapu Anatharac, Ben Hunsberger and - Walter Wartenweiler, Jeff Garbers and David Harris for donating money. + Walter Wartenweiler, Jeff Garbers, David Harris and Terry Brown + for donating money. <li>The Comms group of <a href="http://www.symbian.com">Symbian</a> for donating an ultra cool <a href="http://www.psion.com/revoplus">Revo plus</a> organizer! diff --git a/doc/language.doc b/doc/language.doc index d14bd7e..149686f 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-rc3-20030215), 28 languages +Currently (version 1.2.14-20020317), 28 languages are supported (sorted alphabetically): Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, @@ -79,7 +79,7 @@ when the translator was updated. <TD>Croatian</TD> <TD>Boris Bralo</TD> <TD>boris.bralo@NOSPAM.zg.tel.hr</TD> - <TD>1.2.18</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Czech</TD> @@ -151,7 +151,7 @@ when the translator was updated. <TD>Korean</TD> <TD>Richard Kim</TD> <TD>ryk@NOSPAM.dspwiz.com</TD> - <TD>1.2.13</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Norwegian</TD> @@ -163,7 +163,7 @@ 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>1.2.17</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Portuguese</TD> @@ -239,7 +239,7 @@ when the translator was updated. \hline Chinese Traditional & Gary Lee & {\tt garylee@ecosine.com.tw} & 1.2.16 \\ \hline - Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} & 1.2.18 \\ + 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 \\ \hline @@ -265,11 +265,11 @@ when the translator was updated. Japanese & Ryunosuke Satoh & {\tt sun594@hotmail.com} & up-to-date \\ & Kenji Nagamatsu & {\tt naga@joyful.club.ne.jp} & \\ \hline - Korean & Richard Kim & {\tt ryk@dspwiz.com} & 1.2.13 \\ + Korean & Richard Kim & {\tt ryk@dspwiz.com} & up-to-date \\ \hline Norwegian & Lars Erik Jordet & {\tt lej@circuitry.no} & 1.2.2 \\ \hline - Polish & Piotr Kaminski & {\tt Piotr.Kaminski@ctm.gdynia.pl} & 1.2.17 \\ + 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} & 1.2.18 \\ diff --git a/doc/starting.doc b/doc/starting.doc index a765128..efce614 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -95,6 +95,13 @@ To omit all \c test directories from a source tree for instance, one could use: \verbatim EXCLUDE_PATTERNS = */test/* \endverbatim +Doxygen normally parses files if they are C or C++ sources. If a file +has a <code>.idl</code> or <code>.odl</code> extension it is treated as an +IDL file. If it has a <code>.java</code> extension it is treated as a file +written in Java. Files ending with <code>.cs</code> are treated as C# files. +Finally, files with the extensions <code>.php</code>, <code>.php4</code>, +<code>.inc</code> or <code>.phtml</code> are treated as PHP sources. + If you start using doxygen for an existing project (thus without any documentation that doxygen is aware of), you can still get an idea of what the documented result would be. To do so, you must set |