diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 8 | ||||
| -rw-r--r-- | doc/config.doc | 42 | ||||
| -rw-r--r-- | doc/faq.doc | 38 | ||||
| -rw-r--r-- | doc/index.doc | 3 | ||||
| -rw-r--r-- | doc/language.doc | 8 |
5 files changed, 83 insertions, 16 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 5a6bb82..92491ae 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -280,8 +280,12 @@ 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 located before the function declaration - or definition. A full function declaration should be specified after the + 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 + 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. \par Example: diff --git a/doc/config.doc b/doc/config.doc index 5cbb936..2bccacd 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -71,6 +71,7 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_alphabetical_index ALPHABETICAL_INDEX <li> \refitem cfg_always_detailed_sec ALWAYS_DETAILED_SEC <li> \refitem cfg_bin_abspath BIN_ABSPATH +<li> \refitem cfg_binary_toc BINARY_TOC <li> \refitem cfg_brief_member_desc BRIEF_MEMBER_DESC <li> \refitem cfg_case_sense_names CASE_SENSE_NAMES <li> \refitem cfg_cgi_name CGI_NAME @@ -93,6 +94,7 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_example_patterns EXAMPLE_PATTERNS <li> \refitem cfg_exclude EXCLUDE <li> \refitem cfg_exclude_patterns EXCLUDE_PATTERNS +<li> \refitem cfg_expand_as_defined EXPAND_AS_PREDEFINED <li> \refitem cfg_expand_only_predef EXPAND_ONLY_PREDEF <li> \refitem cfg_ext_doc_paths EXT_DOC_PATHS <li> \refitem cfg_extra_packages EXTRA_PACKAGES @@ -100,7 +102,10 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_extract_private EXTRACT_PRIVATE <li> \refitem cfg_extract_static EXTRACT_STATIC <li> \refitem cfg_file_patterns FILE_PATTERNS +<li> \refitem cfg_filter_source_files FILTER_SOURCE_FILES <li> \refitem cfg_full_path_names FULL_PATH_NAMES +<li> \refitem cfg_generate_buglist GENERATE_BUGLIST +<li> \refitem cfg_generate_chi GENERATE_CHI <li> \refitem cfg_generate_html GENERATE_HTML <li> \refitem cfg_generate_htmlhelp GENERATE_HTMLHELP <li> \refitem cfg_generate_latex GENERATE_LATEX @@ -159,12 +164,14 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_search_includes SEARCH_INCLUDES <li> \refitem cfg_searchengine SEARCHENGINE <li> \refitem cfg_show_include_files SHOW_INCLUDE_FILES +<li> \refitem cfg_show_used_files SHOW_USED_FILES <li> \refitem cfg_sort_member_docs SORT_MEMBER_DOCS <li> \refitem cfg_source_browser SOURCE_BROWSER <li> \refitem cfg_strip_code_comments STRIP_CODE_COMMENTS <li> \refitem cfg_strip_from_path STRIP_FROM_PATH <li> \refitem cfg_tab_size TAB_SIZE <li> \refitem cfg_tagfiles TAGFILES +<li> \refitem cfg_toc_expand TOC_EXPAND <li> \refitem cfg_treeview_width TREEVIEW_WIDTH <li> \refitem cfg_verbatim_headers VERBATIM_HEADERS <li> \refitem cfg_warn_format WARN_FORMAT @@ -430,6 +437,13 @@ followed by the descriptions of the tags grouped by category. disable (NO) the test list. This list is created by putting \ref cmdtest "\\test" commands in the documentation. +\anchor cfg_generate_buglist +<dt>\c GENERATE_BUGLIST <dd> + \addindex GENERATE_BUGLIST + The GENERATE_BUGLIST tag can be used to enable (YES) or + disable (NO) the bug list. This list is created by + putting \ref cmdbug "\\bug" commands in the documentation. + \anchor cfg_aliases <dt>\c ALIASES <dd> \addindex ALIASES @@ -465,6 +479,13 @@ followed by the descriptions of the tags grouped by category. for C. For instance some of the names that are used will be different. The list of all members will be omitted, etc. +\anchor cfg_show_used_files +<dt>\c SHOW_USED_FILES <dd> + \addindex SHOW_USED_FILES + Set the \c SHOW_USED_FILES tag to \c NO to disable the list of files generated + at the bottom of the documentation of classes and structs. If set to \c YES the + list will mention the files that were used to generate the documentation. + </dl> \subsection messages_input Options related to warning and progress messages @@ -744,6 +765,27 @@ 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_generate_chi +<dt>\c GENERATE_CHI <dd> + \addindex GENERATE_CHI + If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c GENERATE_CHI flag + controls if a separate .chi index file is generated (<code>YES</code>) or that + it should be included in the master .chm file (<code>NO</code>). + +\anchor cfg_binary_toc +<dt>\c BINARY_TOC <dd> + \addindex BINARY_TOC + If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c BINARY_TOC flag + controls whether a binary table of contents is generated (<code>YES</code>) or a + normal table of contents (<code>NO</code>) in the .chm file. + +\anchor cfg_toc_expand +<dt>\c TOC_EXPAND <dd> + \addindex TOC_EXPAND + The \c TOC_EXPAND flag can be set YES to add extra items for + group members to the table of contents of the Html help documentation + and to the tree view. + \anchor cfg_disable_index <dt>\c DISABLE_INDEX <dd> \addindex DISABLE_INDEX diff --git a/doc/faq.doc b/doc/faq.doc index 5f38837..4245a74 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -35,6 +35,33 @@ You should use the \\mainpage command inside a comment block like this: */ \endverbatim +<li><b>Help, some/all of the members of my class / file / namespace + are not documented?</b> + + Check the following: + <ol> + <li>Is your class / file / namespace documented? If not, it will not + be extracted from the sources unless \c EXTRACT_ALL is set to \c YES + in the config file. + <li>Are the members private? If so, you must set \c EXTRACT_PRIVATE to \c YES + to make them appear in the documentation. + <li>Is there a function macro in your class that does not end with a + semicolon (e.g. MY_MACRO())? If so then you have to instruct + doxygen's preprocessor to remove it. + + This typically boils down to the following settings in the config file: + + \verbatim +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +PREDEFINED = MY_MACRO()= + \endverbatim + + Please read the \ref preprocessing "preprocessing" section of the + manual for more information. + </ol> + <li><b>When I set EXTRACT_ALL to NO non of my functions are shown in the documentation.</b></li> In order for global functions, variables, enums, typedefs, and defines @@ -64,10 +91,6 @@ around the blocks that should be hidden and put: in the config file then all blocks should be skipped by Doxygen as long as <code>PREPROCESSING = YES</code>. -<li><b>How can I make doxygen ignore nasty macro's? </b> - -Look at section \ref preprocessing for the answer. - <li><b>How can I change what's after the <code>\#include</code> in the class documentation?</b> You can document your class like @@ -145,15 +168,10 @@ The most important reason is too have a platform abstraction for most Unices and Windows by means of the QFile, QFileInfo, QDir, QDate, QTime and QIODevice classes. Another reason is for the nice and bug free utility classes, like QList, -QDict, QString, QArray, QTextStream, QRegExp etc. +QDict, QString, QArray, QTextStream, QRegExp, QXML etc. The GUI front-end doxywizard uses Qt for... well... the GUI! -<li><b>Can I use doxygen on my Java code?</b> - -No, at the moment there is no support for Java. I suggest to -use Sun's JavaDoc instead. - <li><b>How can I exclude all test directories from my directory tree?</b> Simply put an exclude pattern like this in the configuration file: diff --git a/doc/index.doc b/doc/index.doc index 5687c32..99ce67f 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -172,6 +172,9 @@ Thanks go to: Boris Bralo, Nickolay Semyonov, Richard Kim, Földvári György, Grzegorz Kowal, and Wang Weihan for providing translations into various languages. +<li>The Comms group of <a href="http://www.symbian.com">Symbian</a> for donating + me an ultra cool <a href="http://www.psion.com/revoplus>Revo plus</a> + organizer! <li>many, many others for suggestions, patches and bug reports. </ul> */ diff --git a/doc/language.doc b/doc/language.doc index 68871e2..595fa4e 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -148,11 +148,11 @@ Here is a list of the languages and their current maintainers: Russian </TD> <TD> - Nickolay Semyonov + Andrey V. Stolyarov </TD> <TD> - <a href="mailto:snob@NOSPAM.int.spb.ru"> - snob@NOSPAM.int.spb.ru</a> + <a href="mailto:crocodil@NOSPAM.croco.net"> + crocodil@NOSPAM.croco.net</a> </TD> </TR> <TR BGCOLOR="#ffffff"> @@ -246,7 +246,7 @@ Here is a list of the languages and their current maintainers: \hline Finnish & Olli Korhonen & {\tt Olli.Korhonen@ccc.fi} \\ \hline - Russian & Nickolay Semyonov & {\tt snob@int.spb.ru} \\ + Russian & Andrey V. Stolyarov & {\tt crocodil@croco.net} \\ \hline Korean & Richard Kim & {\tt ryk@dspwiz.com} \\ \hline |