diff options
Diffstat (limited to 'doc/config.doc')
| -rw-r--r-- | doc/config.doc | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/config.doc b/doc/config.doc index fa9c5c3..b0043c4 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -155,6 +155,7 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_max_dot_graph_height MAX_DOT_GRAPH_HEIGHT <li> \refitem cfg_max_dot_graph_width MAX_DOT_GRAPH_WIDTH <li> \refitem cfg_max_initializer_lines MAX_INITIALIZER_LINES +<li> \refitem cfg_multiline_cpp_is_brief MULTILINE_CPP_IS_BRIEF <li> \refitem cfg_optimize_output_for_c OPTIMIZE_OUTPUT_FOR_C <li> \refitem cfg_optimize_output_java OPTIMIZE_OUTPUT_JAVA <li> \refitem cfg_output_directory OUTPUT_DIRECTORY @@ -401,6 +402,15 @@ followed by the descriptions of the tags grouped by category. comment as the brief description. If set to NO (the default), the Javadoc-style will behave just like the Qt-style comments. +\anchor cfg_multiline_cpp_is_brief +<dt>\c MULTILINE_CPP_IS_BRIEF <dd> + \addindex MULTILINE_CPP_IS_BRIEF + The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen + treat a multi-line C++ special comment block (i.e. a block of //! or /// + comments) as a brief description. This used to be the default behaviour. + The new default is to treat a multi-line C++ comment block as a detailed + description. Set this tag to YES if you prefer the old behaviour instead. + \anchor cfg_details_at_top <dt>\c DETAILS_AT_TOP <dd> \addindex DETAILS_AT_TOP @@ -1171,7 +1181,8 @@ EXTRA_PACKAGES = times \addindex SKIP_FUNCTION_MACROS If the \c SKIP_FUNCTION_MACROS tag is set to \c YES (the default) then doxygen's preprocessor will remove all function-like macros that are alone - on a line and do not end with a semicolon. Such function macros are typically + on a line, have an all uppercase name, and do not end with a semicolon. + Such function macros are typically used for boiler-plate code, and will confuse the parser if not removed. </dl> |