diff options
| author | Dimitri van Heesch <doxygen@gmail.com> | 2021-03-03 18:54:18 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-03 18:54:18 (GMT) |
| commit | 23a88bee679fb545a4d22ac10f10203cb575056b (patch) | |
| tree | a6943dfa74967be46a5cd65d2c4361afe2d3f0a4 /src/config.xml | |
| parent | 789625caed4097a075819b7d7299ab1a808fcf08 (diff) | |
| parent | cc78ebc6ad3d24d25ac779eeed9fb5fa3c89ee27 (diff) | |
| download | Doxygen-23a88bee679fb545a4d22ac10f10203cb575056b.zip Doxygen-23a88bee679fb545a4d22ac10f10203cb575056b.tar.gz Doxygen-23a88bee679fb545a4d22ac10f10203cb575056b.tar.bz2 | |
Merge branch 'master' into feature/bug_lex
Diffstat (limited to 'src/config.xml')
| -rw-r--r-- | src/config.xml | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/src/config.xml b/src/config.xml index 8526a2b..e9b8323 100644 --- a/src/config.xml +++ b/src/config.xml @@ -1316,22 +1316,33 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn" <docs> <![CDATA[ If the \c WARN_IF_DOC_ERROR tag is set to \c YES, doxygen will generate warnings for - potential errors in the documentation, such as not documenting some - parameters in a documented function, or documenting parameters that + potential errors in the documentation, such as documenting some + parameters in a documented function twice, or documenting parameters that don't exist or using markup commands wrongly. ]]> </docs> </option> + <option type='bool' id='WARN_IF_INCOMPLETE_DOC' defval='1'> + <docs> +<![CDATA[ + If \c WARN_IF_INCOMPLETE_DOC is set to \c YES, doxygen will warn about + incomplete function parameter documentation. + If set to \c NO, doxygen will accept that some parameters have no + documentation without warning. +]]> + </docs> + </option> <option type='bool' id='WARN_NO_PARAMDOC' defval='0'> <docs> <![CDATA[ This \c WARN_NO_PARAMDOC option can be enabled to get warnings for functions that are documented, but have no documentation for their parameters or return value. If set to \c NO, doxygen will only warn about - wrong or incomplete parameter documentation, but not about the absence of + wrong parameter documentation, but not about the absence of documentation. If \ref cfg_extract_all "EXTRACT_ALL" is set to \c YES then this flag will automatically be disabled. + See also \ref cfg_warn_if_incomplete_doc "WARN_IF_INCOMPLETE_DOC" ]]> </docs> </option> @@ -1741,11 +1752,11 @@ to disable this feature. ]]> </docs> </option> - <option type='bool' id='CLANG_ADD_INC_PATHS' setting='USE_LIBCLANG' defval='1'> + <option type='bool' id='CLANG_ADD_INC_PATHS' setting='USE_LIBCLANG' depends='CLANG_ASSISTED_PARSING' defval='1'> <docs> <![CDATA[ - If clang assisted parsing is enabled and the \c CLANG_ADD_INC_PATHS tag - is set to \c YES then doxygen will add the directory of each input to the + If the \c CLANG_ASSISTED_PARSING tag is set to \c YES and the \c CLANG_ADD_INC_PATHS + tag is set to \c YES then doxygen will add the directory of each input to the include path. ]]> </docs> |