diff options
author | Dimitri van Heesch <dimitri@stack.nl> | 2016-12-29 11:09:14 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-12-29 11:09:14 (GMT) |
commit | ee5885770c79733ddd447afb61a2b9cbfcfeb10b (patch) | |
tree | 597f5815997bf136eccccea8865db7b1b19f5264 | |
parent | 4474222932c6ff8bea64917ae1fb089a8390b5a8 (diff) | |
parent | bae3c91812f8a6f845337f8c32d55495c4aa3522 (diff) | |
download | Doxygen-ee5885770c79733ddd447afb61a2b9cbfcfeb10b.zip Doxygen-ee5885770c79733ddd447afb61a2b9cbfcfeb10b.tar.gz Doxygen-ee5885770c79733ddd447afb61a2b9cbfcfeb10b.tar.bz2 |
Merge pull request #550 from artur-kink/master
Check for undocumented params warnings if members detailed documentat…
-rw-r--r-- | src/memberdef.cpp | 47 | ||||
-rw-r--r-- | src/memberdef.h | 1 |
2 files changed, 28 insertions, 20 deletions
diff --git a/src/memberdef.cpp b/src/memberdef.cpp index 8f1573c..d37efb9 100644 --- a/src/memberdef.cpp +++ b/src/memberdef.cpp @@ -3013,26 +3013,7 @@ void MemberDef::writeDocumentation(MemberList *ml, //if (Config_getBool(EXTRACT_ALL) && !hasDocs) ol.enable(OutputGenerator::Latex); ol.popGeneratorState(); - //------------------------------------------------ - - if (!Config_getBool(EXTRACT_ALL) && - Config_getBool(WARN_IF_UNDOCUMENTED) && - Config_getBool(WARN_NO_PARAMDOC) && - !Doxygen::suppressDocWarnings) - { - if (!hasDocumentedParams()) - { - warn_doc_error(getDefFileName(),getDefLine(), - "parameters of member %s are not (all) documented", - qPrint(qualifiedName())); - } - if (!hasDocumentedReturnType() && isFunction() && hasDocumentation()) - { - warn_doc_error(getDefFileName(),getDefLine(), - "return type of member %s is not documented", - qPrint(qualifiedName())); - } - } + warnIfUndocumentedParams(); } // strip scope and field name from the type @@ -3267,9 +3248,35 @@ void MemberDef::warnIfUndocumented() warn_undoc(getDefFileName(),getDefLine(),"Member %s%s (%s) of %s %s is not documented.", qPrint(name()),qPrint(argsString()),qPrint(memberTypeName()),t,qPrint(d->name())); } + else if (!isDetailedSectionLinkable()) + { + warnIfUndocumentedParams(); + } } +void MemberDef::warnIfUndocumentedParams() +{ + if (!Config_getBool(EXTRACT_ALL) && + Config_getBool(WARN_IF_UNDOCUMENTED) && + Config_getBool(WARN_NO_PARAMDOC) && + !Doxygen::suppressDocWarnings) + { + if (!hasDocumentedParams()) + { + warn_doc_error(getDefFileName(),getDefLine(), + "parameters of member %s are not (all) documented", + qPrint(qualifiedName())); + } + if (!hasDocumentedReturnType() && + isFunction() && hasDocumentation()) + { + warn_doc_error(getDefFileName(),getDefLine(), + "return type of member %s is not documented", + qPrint(qualifiedName())); + } + } +} bool MemberDef::isFriendClass() const { diff --git a/src/memberdef.h b/src/memberdef.h index cda1baf..c0825b2 100644 --- a/src/memberdef.h +++ b/src/memberdef.h @@ -389,6 +389,7 @@ class MemberDef : public Definition ClassDef *cd,NamespaceDef *nd,FileDef *fd,GroupDef *gd); void writeTagFile(FTextStream &); void warnIfUndocumented(); + void warnIfUndocumentedParams(); MemberDef *createTemplateInstanceMember(ArgumentList *formalArgs, ArgumentList *actualArgs); |