diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.doc | 49 | ||||
| -rw-r--r-- | doc/faq.doc | 10 | ||||
| -rw-r--r-- | doc/features.doc | 2 | ||||
| -rw-r--r-- | doc/index.doc | 4 | ||||
| -rw-r--r-- | doc/language.doc | 35 |
5 files changed, 91 insertions, 9 deletions
diff --git a/doc/config.doc b/doc/config.doc index 063f634..a73463b 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -66,6 +66,7 @@ followed by the descriptions of the tags grouped by category. \begin{multicols}{3} \begin{CompactList} \endlatexonly +<li> \refitem cfg_aliases ALIASES <li> \refitem cfg_allexternals ALLEXTERNALS <li> \refitem cfg_alphabetical_index ALPHABETICAL_INDEX <li> \refitem cfg_always_detailed_sec ALWAYS_DETAILED_SEC @@ -81,6 +82,7 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_compact_latex COMPACT_LATEX <li> \refitem cfg_compact_rtf COMPACT_RTF <li> \refitem cfg_disable_index DISABLE_INDEX +<li> \refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC <li> \refitem cfg_doc_abspath DOC_ABSPATH <li> \refitem cfg_doc_url DOC_URL <li> \refitem cfg_dot_path DOT_PATH @@ -104,6 +106,8 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_generate_man GENERATE_MAN <li> \refitem cfg_generate_rtf GENERATE_RTF <li> \refitem cfg_generate_tagfile GENERATE_TAGFILE +<li> \refitem cfg_generate_testlist GENERATE_TESTLIST +<li> \refitem cfg_generate_todolist GENERATE_TODOLIST <li> \refitem cfg_graphical_hierarchy GRAPHICAL_HIERARCHY <li> \refitem cfg_have_dot HAVE_DOT <li> \refitem cfg_hide_scope_names HIDE_SCOPE_NAMES @@ -203,8 +207,8 @@ followed by the descriptions of the tags grouped by category. documentation generated by doxygen is written. Doxygen will use this information to generate all constant output in the proper language. The default language is English, other supported languages are: - Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese, - Spanish, Russian, Croatian, Polish and Portuguese. + Dutch, French, Italian, Czech, Swedish, German, Finnish, Hungarian, Japanese, + Korean, Spanish, Russian, Croatian, Polish and Portuguese. \anchor cfg_disable_index <dt>\c DISABLE_INDEX <dd> @@ -392,6 +396,14 @@ followed by the descriptions of the tags grouped by category. alphabetically by member name. If set to \c NO the members will appear in declaration order. +\anchor cfg_distribute_group_doc +<dt>\c DISTRIBUTE_GROUP_DOC <dd> + \addindex DISTRIBUTE_GROUP_DOC + If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC + tag is set to YES, then doxygen will reuse the documentation of the first + member in the group (if any) for the other members of the group. By default + all members of a group must be documented explicitly. + \anchor cfg_tab_size <dt>\c TAB_SIZE <dd> \addindex TAB_SIZE @@ -405,6 +417,39 @@ followed by the descriptions of the tags grouped by category. documentation sections, marked by \ref cmdif "\\if" \<section-label\> ... \ref cmdendif "\\endif" blocks. +\anchor cfg_generate_todolist +<dt>\c GENERATE_TODOLIST <dd> + \addindex GENERATE_TODOLIST + The GENERATE_TODOLIST tag can be used to enable (YES) or + disable (NO) the todo list. This list is created by + putting \ref cmdtodo "\\todo" + commands in the documentation. + +\anchor cfg_generate_testlist +<dt>\c GENERATE_TESTLIST <dd> + \addindex GENERATE_TESTLIST + The GENERATE_TESTLIST tag can be used to enable (YES) or + disable (NO) the test list. This list is created by + putting \ref cmdtest "\\test" commands in the documentation. + +\anchor cfg_aliases +<dt>\c ALIASES <dd> + \addindex ALIASES + This tag can be used to specify a number of aliases that acts + as commands in the documentation. An alias has the form +\verbatim + name=value +\endverbatim + For example adding +\verbatim + "sideeffect=\par Side Effects:\n" +\endverbatim + will allow you to + put the command \\sideeffect (or \@sideeffect) in the documentation, which + will result in a user defined paragraph with heading "Side Effects:". + You can put \\n's in the value part of an alias to insert newlines. + Predefined commands cannot be overwritten using aliases. + </dl> \subsection messages_input Options related to warning and progress messages diff --git a/doc/faq.doc b/doc/faq.doc index 4606a19..6464c0b 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -169,6 +169,16 @@ EXCLUDE_PATTERNS = */test/* Put a \% in front of the class name. Like this: \%MyClass. Doxygen will then remove the % and keep the word unlinked. +<li><b>Help! I get the cryptic message + "input buffer overflow, can't enlarge buffer because scanner uses REJECT"</b> + +This error happens when doxygen lexical scanner has a rules that matches +more than 16K input character in one go. I've seen this happening +on a very large generated file (>16K lines), where the built-in preprocessor +converted it into an empty file (with >16K of newlines). Another case +where this might happen is if you have lines in you code with more than +16K characters. + </ol> \htmlonly diff --git a/doc/features.doc b/doc/features.doc index 3298b0b..1fe463f 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -23,7 +23,7 @@ <li>Requires very little overhead from the writer of the documentation. Plain text will do, but for more fancy or structured output HTML tags and/or some of doxygen's special commands can be used. -<li>Supports C++, (Corba and Microsoft) IDL and C sources. +<li>Supports C++, (Corba, Microsoft, and KDE-DCOP) IDL and C sources. <li>Supports documentation of files, namespaces, classes, structs, unions, templates, variables, functions, typedefs, enums and defines. <li>JavaDoc (1.1), Qt-Doc, and KDOC compatible. diff --git a/doc/index.doc b/doc/index.doc index 9c7619f..0f7023f 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -49,8 +49,8 @@ Documents produced by Doxygen are derivative works derived from the input used in their production; they are not affected by this license. <h2>Introduction</h2> -Doxygen is a documentation system for C++, IDL (Corba and Microsoft flavors) -and C. +Doxygen is a documentation system for C++, IDL +(Corba, Microsoft and KDE-DCOP flavors) and C. It can help you in three ways: <ol> diff --git a/doc/language.doc b/doc/language.doc index 0c19968..b75e843 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -22,9 +22,9 @@ Doxygen has support for multiple languages. This means that the text fragments t doxygen generates can changed into languages other than English (the default) at configuration time. <p> -Currently, supported languages are English, French, Czech, Dutch, -Swedish, Italian, German and Japanese. A number -of people have volunteered to add support for other languages as well. +Currently, supported languages are English, French, Czech, Dutch, Spannish, +Swedish, Russian, Czech, Croatian, Italian, Hungarian, Finnish, German and Japanese, +and Korean. Here is a list of the languages and their current maintainers: <p> @@ -157,6 +157,30 @@ Here is a list of the languages and their current maintainers: </TR> <TR BGCOLOR="#ffffff"> <TD> + Korean + </TD> + <TD> + Richard Kim + </TD> + <TD> + <a href="mailto:ryk@NOSPAM.dspwiz.com"> + ryk@NOSPAM.dspwiz.com</a> + </TD> + </TR> + <TR BGCOLOR="#ffffff"> + <TD> + Hungarian + </TD> + <TD> + Földvári György + </TD> + <TD> + <a href="mailto:foldvari@NOSPAM.diatronltd.com"> + foldvari@NOSPAM.diatronltd.com</a> + </TD> + </TR> + <TR BGCOLOR="#ffffff"> + <TD> Croatian </TD> <TD> @@ -167,7 +191,6 @@ Here is a list of the languages and their current maintainers: boris.bralo@NOSPAM.zg.tel.hr</a> </TD> </TR> - <TR BGCOLOR="#ffffff"> <TD> Polish @@ -225,6 +248,10 @@ Here is a list of the languages and their current maintainers: \hline Russian & Nickolay Semyonov & {\tt snob@int.spb.ru} \\ \hline + Korean & Richard Kim & {\\tt ryk@dspwiz.com} \\ + \hline + Hungarian & Földvári György & {\\tt foldvari@diatronltd.com} \\ + \hline Croatian & Boris Bralo & {\tt boris.bralo@zg.tel.hr} \\ \hline Polish & Grzegorz Kowal & {\tt g\_kowal@poczta.onet.pl} \\ |