Skip to content

Commit faac731

Browse files
author
Dimitri van Heesch
committed
Merge branch 'master' of github.com:doxygen/doxygen
2 parents 5730198 + ee58857 commit faac731

File tree

2 files changed

+28
-20
lines changed

2 files changed

+28
-20
lines changed

src/memberdef.cpp

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3013,26 +3013,7 @@ void MemberDef::writeDocumentation(MemberList *ml,
30133013
//if (Config_getBool(EXTRACT_ALL) && !hasDocs) ol.enable(OutputGenerator::Latex);
30143014
ol.popGeneratorState();
30153015

3016-
//------------------------------------------------
3017-
3018-
if (!Config_getBool(EXTRACT_ALL) &&
3019-
Config_getBool(WARN_IF_UNDOCUMENTED) &&
3020-
Config_getBool(WARN_NO_PARAMDOC) &&
3021-
!Doxygen::suppressDocWarnings)
3022-
{
3023-
if (!hasDocumentedParams())
3024-
{
3025-
warn_doc_error(getDefFileName(),getDefLine(),
3026-
"parameters of member %s are not (all) documented",
3027-
qPrint(qualifiedName()));
3028-
}
3029-
if (!hasDocumentedReturnType() && isFunction() && hasDocumentation())
3030-
{
3031-
warn_doc_error(getDefFileName(),getDefLine(),
3032-
"return type of member %s is not documented",
3033-
qPrint(qualifiedName()));
3034-
}
3035-
}
3016+
warnIfUndocumentedParams();
30363017
}
30373018

30383019
// strip scope and field name from the type
@@ -3267,9 +3248,35 @@ void MemberDef::warnIfUndocumented()
32673248
warn_undoc(getDefFileName(),getDefLine(),"Member %s%s (%s) of %s %s is not documented.",
32683249
qPrint(name()),qPrint(argsString()),qPrint(memberTypeName()),t,qPrint(d->name()));
32693250
}
3251+
else if (!isDetailedSectionLinkable())
3252+
{
3253+
warnIfUndocumentedParams();
3254+
}
32703255
}
32713256

32723257

3258+
void MemberDef::warnIfUndocumentedParams()
3259+
{
3260+
if (!Config_getBool(EXTRACT_ALL) &&
3261+
Config_getBool(WARN_IF_UNDOCUMENTED) &&
3262+
Config_getBool(WARN_NO_PARAMDOC) &&
3263+
!Doxygen::suppressDocWarnings)
3264+
{
3265+
if (!hasDocumentedParams())
3266+
{
3267+
warn_doc_error(getDefFileName(),getDefLine(),
3268+
"parameters of member %s are not (all) documented",
3269+
qPrint(qualifiedName()));
3270+
}
3271+
if (!hasDocumentedReturnType() &&
3272+
isFunction() && hasDocumentation())
3273+
{
3274+
warn_doc_error(getDefFileName(),getDefLine(),
3275+
"return type of member %s is not documented",
3276+
qPrint(qualifiedName()));
3277+
}
3278+
}
3279+
}
32733280

32743281
bool MemberDef::isFriendClass() const
32753282
{

src/memberdef.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -389,6 +389,7 @@ class MemberDef : public Definition
389389
ClassDef *cd,NamespaceDef *nd,FileDef *fd,GroupDef *gd);
390390
void writeTagFile(FTextStream &);
391391
void warnIfUndocumented();
392+
void warnIfUndocumentedParams();
392393

393394
MemberDef *createTemplateInstanceMember(ArgumentList *formalArgs,
394395
ArgumentList *actualArgs);

0 commit comments

Comments
 (0)