diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.doc | 20 | ||||
| -rw-r--r-- | doc/starting.doc | 7 |
2 files changed, 22 insertions, 5 deletions
diff --git a/doc/config.doc b/doc/config.doc index 9bb5b46..06871ac 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -51,6 +51,7 @@ followed by the descriptions of the tags grouped by category. \begin{CompactList} \endlatexonly <li> \refitem cfg_allexternals ALLEXTERNALS +<li> \refitem cfg_always_detailed_sec ALWAYS_DETAILED_SEC <li> \refitem cfg_alphabetical_index ALPHABETICAL_INDEX <li> \refitem cfg_bin_abspath BIN_ABSPATH <li> \refitem cfg_brief_member_desc BRIEF_MEMBER_DESC @@ -121,6 +122,7 @@ 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_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 @@ -260,6 +262,12 @@ followed by the descriptions of the tags grouped by category. If both \c HIDE_UNDOC_MEMBERS and \c BRIEF_MEMBER_DESC are set to \c NO, the brief descriptions will be completely suppressed. +\anchor cfg_always_detailed_sec +<dt>\c ALWAYS_DETAILED_SEC <dd> +If the \c ALWAYS_DETAILED_SEC and \c REPEAT_BRIEF tags are both set to \c YES then +Doxygen will generate a detailed section even if there is only a brief +description. + \anchor cfg_full_path_names <dt>\c FULL_PATH_NAMES <dd> \addindex FULL_PATH_NAMES @@ -342,12 +350,22 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_inline_info <dt>\c INLINE_INFO <dd> + \addindex INLINE_INFO If the \c INLINE_INFO tag is set to \c YES (the default) then a tag [inline] is inserted in the documentation for inline members. +\anchor cfg_sort_member_docs +<dt>\c SORT_MEMBER_DOCS <dd> + \addindex SORT_MEMBER_DOCS + If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen + will sort the (detailed) documentation of file and class members + alphabetically by member name. If set to NO the members will appear in + declaration order. + \anchor cfg_tab_size <dt>\c TAB_SIZE <dd> - the TAB_SIZE tag can be used to set the number of spaces in a tab. + \addindex TAB_SIZE + the \c TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen uses this value to replace tabs by spaces in code fragments. </dl> diff --git a/doc/starting.doc b/doc/starting.doc index 1b0f0a8..96a2fc1 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -495,12 +495,11 @@ Go to the <a href="diagrams.html">next</a> section or return to the Doxygen uses the "dot" tool to generate the following graphs: <ul> <li>if \ref cfg_graphical_hierarchy "GRAPHICAL_HIERARCHY" is set to \c YES, - a graphical representation of the class diagram will be drawn, along + a graphical representation of the class hierarchy will be drawn, along with the textual one. Currently this feature is supported for HTML only.\n <b>Warning:</b> When you have a very large class hierarchy where many - classes derive from a common - base class, the resulting image may become too big to handle for some - browsers. + classes derive from a common base class, the resulting image may become + too big to handle for some browsers. <li>if \ref cfg_include_graph "INCLUDE_GRAPH" is set to \c YES, an include dependency graph is generated for each documented file that includes at least one other file. This feature is currently supported for HTML and RTF |