diff options
Diffstat (limited to 'doc/config.doc')
| -rw-r--r-- | doc/config.doc | 49 |
1 files changed, 47 insertions, 2 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 |