diff options
| author | James Wilcox <wilcoxjay@gmail.com> | 2013-08-11 17:30:38 (GMT) |
|---|---|---|
| committer | arwedus <70707249+arwedus@users.noreply.github.com> | 2021-02-13 00:28:55 (GMT) |
| commit | af06f361f3d0ae240de63ce6bf5137dab247cc46 (patch) | |
| tree | 2c2336010f975141b21b26465a43ff755098e2a4 /src/config.xml | |
| parent | a136cfef5489af08ada5ed8c928a5876133b9f3e (diff) | |
| download | Doxygen-af06f361f3d0ae240de63ce6bf5137dab247cc46.zip Doxygen-af06f361f3d0ae240de63ce6bf5137dab247cc46.tar.gz Doxygen-af06f361f3d0ae240de63ce6bf5137dab247cc46.tar.bz2 | |
add config option WARN_IF_INCOMPLETE_DOC
Add a new warning class, "INCOMPLETE_DOC", and warning option
"WARN_IF_INCOMPLETE_DOC", to control whether you get a warning
for only documenting some of your function parameters.
All users who want to retain the current behavior set
WARN_IF_INCOMPLETE_DOC to the value of WARN_IF_DOC_ERROR.
Diffstat (limited to 'src/config.xml')
| -rw-r--r-- | src/config.xml | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/src/config.xml b/src/config.xml index d9b29aa..c704916 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_paramdoc "WARN_IF_INCOMPLETE_PARAMDOC" ]]> </docs> </option> |