Skip to content

Commit ffcfe7d

Browse files
albert-githubalbert-github
committed
bug 512677 New command specifying an empty comment
- merging documentation sections also implies merging trivial flag - small documentation correction
1 parent 6aa70ec commit ffcfe7d

File tree

6 files changed

+41
-2
lines changed

6 files changed

+41
-2
lines changed

‎doc/commands.dox‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1515,8 +1515,8 @@ Description
15151515
\section cmdtrivial \\trivial
15161516

15171517
\addindex \\trivial
1518-
Indicates that the entity doesn't need documentation as it is "trivial", but that it should be
1519-
show in the documentation anyway.
1518+
Indicates that the entity doesn't need documentation as it is "trivial", but that it should
1519+
anyway be shown in the documentation.
15201520

15211521
\sa \ref cfg_extract_all "EXTRACT_ALL"
15221522

‎src/classdef.cpp‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -874,6 +874,7 @@ std::unique_ptr<ClassDef> ClassDefImpl::deepCopy(const QCString &name) const
874874
getDefFileName(),getDefLine(),getDefColumn(),name,compoundType(),
875875
std::string(),std::string(),true,m_isJavaEnum);
876876
result->setBriefDescription(briefDescription(),briefFile(),briefLine());
877+
result->setIsTrivial(isTrivial());
877878
result->setDocumentation(documentation(),docFile(),docLine());
878879
result->setInbodyDocumentation(inbodyDocumentation(),inbodyFile(),inbodyLine());
879880
result->setBodySegment(getStartDefLine(),getStartBodyLine(),getEndBodyLine());
@@ -4436,6 +4437,7 @@ void ClassDefImpl::addMemberToTemplateInstance(const MemberDef *md,
44364437
mmd->setTemplateMaster(md);
44374438
mmd->setDocumentation(md->documentation(),md->docFile(),md->docLine());
44384439
mmd->setBriefDescription(md->briefDescription(),md->briefFile(),md->briefLine());
4440+
mmd->setIsTrivial(mmd->isTrivial() || md->isTrivial());
44394441
mmd->setInbodyDocumentation(md->inbodyDocumentation(),md->inbodyFile(),md->inbodyLine());
44404442
mmd->setMemberSpecifiers(md->getMemberSpecifiers());
44414443
mmd->setMemberGroupId(md->getMemberGroupId());

‎src/doxygen.cpp‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -973,6 +973,7 @@ static void addClassToContext(const Entry *root)
973973

974974
cd->setDocumentation(root->doc,root->docFile,root->docLine);
975975
cd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
976+
cd->setIsTrivial(root->isTrivial || cd->isTrivial());
976977
root->commandOverrides.apply_collaborationGraph([&](bool b ) { cd->overrideCollaborationGraph(b); });
977978
root->commandOverrides.apply_inheritanceGraph ([&](CLASS_GRAPH_t gt) { cd->overrideInheritanceGraph(gt); });
978979

@@ -1067,6 +1068,7 @@ static void addClassToContext(const Entry *root)
10671068
fmt::ptr(tagInfo),root->hidden,root->artificial);
10681069
cd->setDocumentation(root->doc,root->docFile,root->docLine); // copy docs to definition
10691070
cd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
1071+
cd->setIsTrivial(root->isTrivial || cd->isTrivial());
10701072
cd->setLanguage(root->lang);
10711073
cd->setId(root->id);
10721074
cd->setHidden(root->hidden);
@@ -1496,6 +1498,7 @@ static ClassDefMutable *createTagLessInstance(const ClassDef *rootCd,const Class
14961498
{
14971499
cd->setDocumentation(templ->documentation(),templ->docFile(),templ->docLine()); // copy docs to definition
14981500
cd->setBriefDescription(templ->briefDescription(),templ->briefFile(),templ->briefLine());
1501+
cd->setIsTrivial(templ->isTrivial() || cd->isTrivial());
14991502
cd->setLanguage(templ->getLanguage());
15001503
cd->setBodySegment(templ->getDefLine(),templ->getStartBodyLine(),templ->getEndBodyLine());
15011504
cd->setBodyDef(templ->getBodyDef());
@@ -1537,6 +1540,7 @@ static ClassDefMutable *createTagLessInstance(const ClassDef *rootCd,const Class
15371540
imd->setMemberClass(cd);
15381541
imd->setDocumentation(md->documentation(),md->docFile(),md->docLine());
15391542
imd->setBriefDescription(md->briefDescription(),md->briefFile(),md->briefLine());
1543+
imd->setIsTrivial(imd->isTrivial() || md->isTrivial());
15401544
imd->setInbodyDocumentation(md->inbodyDocumentation(),md->inbodyFile(),md->inbodyLine());
15411545
imd->setMemberSpecifiers(md->getMemberSpecifiers());
15421546
imd->setVhdlSpecifiers(md->getVhdlSpecifiers());
@@ -1702,6 +1706,7 @@ static void buildNamespaceList(const Entry *root)
17021706
nd->setName(fullName); // change name to match docs
17031707
nd->addSectionsToDefinition(root->anchors);
17041708
nd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
1709+
nd->setIsTrivial(root->isTrivial || nd->isTrivial());
17051710
if (nd->getLanguage()==SrcLangExt::Unknown)
17061711
{
17071712
nd->setLanguage(root->lang);
@@ -1750,6 +1755,7 @@ static void buildNamespaceList(const Entry *root)
17501755
{
17511756
nd->setDocumentation(root->doc,root->docFile,root->docLine); // copy docs to definition
17521757
nd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
1758+
nd->setIsTrivial(root->isTrivial || nd->isTrivial());
17531759
nd->addSectionsToDefinition(root->anchors);
17541760
nd->setHidden(root->hidden);
17551761
nd->setArtificial(root->artificial);
@@ -1769,6 +1775,7 @@ static void buildNamespaceList(const Entry *root)
17691775

17701776
// the empty string test is needed for extract all case
17711777
nd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
1778+
nd->setIsTrivial(root->isTrivial || nd->isTrivial());
17721779
nd->insertUsedFile(fd);
17731780
nd->setBodySegment(root->startLine,root->bodyLine,root->endBodyLine);
17741781
nd->setBodyDef(fd);
@@ -1955,6 +1962,7 @@ static void findUsingDirectives(const Entry *root)
19551962
{
19561963
nd->setDocumentation(root->doc,root->docFile,root->docLine); // copy docs to definition
19571964
nd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
1965+
nd->setIsTrivial(root->isTrivial || nd->isTrivial());
19581966
nd->addSectionsToDefinition(root->anchors);
19591967
nd->setHidden(root->hidden);
19601968
nd->setArtificial(TRUE);
@@ -1980,6 +1988,7 @@ static void findUsingDirectives(const Entry *root)
19801988

19811989
// the empty string test is needed for extract all case
19821990
nd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
1991+
nd->setIsTrivial(root->isTrivial || nd->isTrivial());
19831992
nd->insertUsedFile(fd);
19841993
nd->setRefItems(root->sli);
19851994
}
@@ -2128,12 +2137,14 @@ static void createUsingMemberImportForClass(const Entry *root,ClassDefMutable *c
21282137
{
21292138
newMmd->setDocumentation(root->doc,root->docFile,root->docLine);
21302139
newMmd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
2140+
newMmd->setIsTrivial(root->isTrivial || newMmd->isTrivial());
21312141
newMmd->setInbodyDocumentation(root->inbodyDocs,root->inbodyFile,root->inbodyLine);
21322142
}
21332143
else
21342144
{
21352145
newMmd->setDocumentation(md->documentation(),md->docFile(),md->docLine());
21362146
newMmd->setBriefDescription(md->briefDescription(),md->briefFile(),md->briefLine());
2147+
newMmd->setIsTrivial(md->isTrivial() || newMmd->isTrivial());
21372148
newMmd->setInbodyDocumentation(md->inbodyDocumentation(),md->inbodyFile(),md->inbodyLine());
21382149
}
21392150
newMmd->setDefinition(md->definition());
@@ -2354,11 +2365,13 @@ static void findUsingDeclImports(const Entry *root)
23542365
{
23552366
ncdm->setDocumentation(root->doc,root->docFile,root->docLine);
23562367
ncdm->setBriefDescription(root->brief,root->briefFile,root->briefLine);
2368+
ncdm->setIsTrivial(root->isTrivial || ncdm->isTrivial());
23572369
}
23582370
else // use docs from used class
23592371
{
23602372
ncdm->setDocumentation(cd->documentation(),cd->docFile(),cd->docLine());
23612373
ncdm->setBriefDescription(cd->briefDescription(),cd->briefFile(),cd->briefLine());
2374+
ncdm->setIsTrivial(cd->isTrivial() || ncdm->isTrivial());
23622375
}
23632376
if (nd)
23642377
{
@@ -2537,6 +2550,7 @@ static MemberDef *addVariableToClass(
25372550
mmd->setMemberClass(cd); // also sets outer scope (i.e. getOuterScope())
25382551
mmd->setDocumentation(root->doc,root->docFile,root->docLine);
25392552
mmd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
2553+
mmd->setIsTrivial(root->isTrivial || mmd->isTrivial());
25402554
mmd->setInbodyDocumentation(root->inbodyDocs,root->inbodyFile,root->inbodyLine);
25412555
mmd->setDefinition(def);
25422556
mmd->setBitfields(root->bitfields);
@@ -2620,6 +2634,7 @@ static MemberDef *addVariableToFile(
26202634
cd->setClassName(name);
26212635
cd->setDocumentation(root->doc,root->docFile,root->docLine);
26222636
cd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
2637+
cd->setIsTrivial(root->isTrivial || cd->isTrivial());
26232638
return nullptr;
26242639
}
26252640
}
@@ -2766,6 +2781,7 @@ static MemberDef *addVariableToFile(
27662781
mmd->setVhdlSpecifiers(root->vhdlSpec);
27672782
mmd->setDocumentation(root->doc,root->docFile,root->docLine);
27682783
mmd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
2784+
mmd->setIsTrivial(root->isTrivial || mmd->isTrivial());
27692785
mmd->setInbodyDocumentation(root->inbodyDocs,root->inbodyFile,root->inbodyLine);
27702786
mmd->addSectionsToDefinition(root->anchors);
27712787
mmd->setFromAnonymousScope(fromAnnScope);
@@ -3404,6 +3420,7 @@ static void buildTypedefList(const Entry *root)
34043420
md->setInbodyDocumentation(root->inbodyDocs,root->inbodyFile,root->inbodyLine);
34053421
md->setDocsForDefinition(!root->proto);
34063422
md->setBriefDescription(root->brief,root->briefFile,root->briefLine);
3423+
md->setIsTrivial(root->isTrivial || md->isTrivial());
34073424
md->addSectionsToDefinition(root->anchors);
34083425
md->setRefItems(root->sli);
34093426
md->addQualifiers(root->qualifiers);
@@ -3541,6 +3558,7 @@ static void addInterfaceOrServiceToServiceOrSingleton(
35413558
mmd->setDocumentation(root->doc,root->docFile,root->docLine);
35423559
mmd->setDocsForDefinition(false);
35433560
mmd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
3561+
mmd->setIsTrivial(root->isTrivial || mmd->isTrivial());
35443562
mmd->setInbodyDocumentation(root->inbodyDocs,root->inbodyFile,root->inbodyLine);
35453563
mmd->setBodySegment(root->startLine,root->bodyLine,root->endBodyLine);
35463564
mmd->setMemberSpecifiers(root->spec);
@@ -3696,6 +3714,7 @@ static void addMethodToClass(const Entry *root,ClassDefMutable *cd,
36963714
mmd->setDocumentation(root->doc,root->docFile,root->docLine);
36973715
mmd->setDocsForDefinition(!root->proto);
36983716
mmd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
3717+
mmd->setIsTrivial(root->isTrivial || mmd->isTrivial());
36993718
mmd->setInbodyDocumentation(root->inbodyDocs,root->inbodyFile,root->inbodyLine);
37003719
mmd->setBodySegment(root->startLine,root->bodyLine,root->endBodyLine);
37013720
mmd->setMemberSpecifiers(spec);
@@ -3788,6 +3807,7 @@ static void addGlobalFunction(const Entry *root,const QCString &rname,const QCSt
37883807
mmd->setId(root->id);
37893808
mmd->setDocumentation(root->doc,root->docFile,root->docLine);
37903809
mmd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
3810+
mmd->setIsTrivial(root->isTrivial || mmd->isTrivial());
37913811
mmd->setInbodyDocumentation(root->inbodyDocs,root->inbodyFile,root->inbodyLine);
37923812
mmd->setPrototype(root->proto,root->fileName,root->startLine,root->startColumn);
37933813
mmd->setDocsForDefinition(!root->proto);
@@ -4105,6 +4125,7 @@ static void buildFunctionList(const Entry *root)
41054125
md->setArgsString(root->args);
41064126
}
41074127
md->setBriefDescription(root->brief,root->briefFile,root->briefLine);
4128+
md->setIsTrivial(root->isTrivial || md->isTrivial());
41084129

41094130
md->addSectionsToDefinition(root->anchors);
41104131

@@ -4237,10 +4258,12 @@ static void findFriends()
42374258
if (mmd->briefDescription().isEmpty() && !fmd->briefDescription().isEmpty())
42384259
{
42394260
mmd->setBriefDescription(fmd->briefDescription(),fmd->briefFile(),fmd->briefLine());
4261+
mmd->setIsTrivial(fmd->isTrivial() || mmd->isTrivial());
42404262
}
42414263
else if (!mmd->briefDescription().isEmpty() && !fmd->briefDescription().isEmpty())
42424264
{
42434265
fmd->setBriefDescription(mmd->briefDescription(),mmd->briefFile(),mmd->briefLine());
4266+
fmd->setIsTrivial(fmd->isTrivial() || mmd->isTrivial());
42444267
}
42454268
if (!fmd->inbodyDocumentation().isEmpty())
42464269
{
@@ -5697,6 +5720,7 @@ static void addMemberDocs(const Entry *root,
56975720

56985721
//printf("overwrite!\n");
56995722
md->setBriefDescription(root->brief,root->briefFile,root->briefLine);
5723+
md->setIsTrivial(root->isTrivial || md->isTrivial());
57005724

57015725
if (
57025726
(md->inbodyDocumentation().isEmpty() ||
@@ -6204,6 +6228,7 @@ static void addLocalObjCMethod(const Entry *root,
62046228
mmd->addQualifiers(root->qualifiers);
62056229
mmd->setDocumentation(root->doc,root->docFile,root->docLine);
62066230
mmd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
6231+
mmd->setIsTrivial(root->isTrivial || mmd->isTrivial());
62076232
mmd->setInbodyDocumentation(root->inbodyDocs,root->inbodyFile,root->inbodyLine);
62086233
mmd->setDocsForDefinition(!root->proto);
62096234
mmd->setPrototype(root->proto,root->fileName,root->startLine,root->startColumn);
@@ -6629,6 +6654,7 @@ static void addMemberSpecialization(const Entry *root,
66296654
mmd->addQualifiers(root->qualifiers);
66306655
mmd->setDocumentation(root->doc,root->docFile,root->docLine);
66316656
mmd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
6657+
mmd->setIsTrivial(root->isTrivial || mmd->isTrivial());
66326658
mmd->setInbodyDocumentation(root->inbodyDocs,root->inbodyFile,root->inbodyLine);
66336659
mmd->setDocsForDefinition(!root->proto);
66346660
mmd->setPrototype(root->proto,root->fileName,root->startLine,root->startColumn);
@@ -6696,6 +6722,7 @@ static void addOverloaded(const Entry *root,MemberName *mn,
66966722
doc+=root->doc;
66976723
mmd->setDocumentation(doc,root->docFile,root->docLine);
66986724
mmd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
6725+
mmd->setIsTrivial(root->isTrivial || mmd->isTrivial());
66996726
mmd->setInbodyDocumentation(root->inbodyDocs,root->inbodyFile,root->inbodyLine);
67006727
mmd->setDocsForDefinition(!root->proto);
67016728
mmd->setPrototype(root->proto,root->fileName,root->startLine,root->startColumn);
@@ -7318,6 +7345,7 @@ static void findMember(const Entry *root,
73187345
mmd->setDocsForDefinition(!root->proto);
73197346
mmd->setPrototype(root->proto,root->fileName,root->startLine,root->startColumn);
73207347
mmd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
7348+
mmd->setIsTrivial(root->isTrivial || mmd->isTrivial());
73217349
mmd->addSectionsToDefinition(root->anchors);
73227350
mmd->setMemberGroupId(root->mGrpId);
73237351
mmd->setLanguage(root->lang);
@@ -7747,6 +7775,7 @@ static void findEnums(const Entry *root)
77477775
mmd->setDocumentation(root->doc,root->docFile,root->docLine);
77487776
mmd->setDocsForDefinition(!root->proto);
77497777
mmd->setBriefDescription(root->brief,root->briefFile,root->briefLine);
7778+
mmd->setIsTrivial(root->isTrivial || mmd->isTrivial());
77507779
mmd->setInbodyDocumentation(root->inbodyDocs,root->inbodyFile,root->inbodyLine);
77517780

77527781
//printf("Adding member=%s\n",qPrint(md->name()));
@@ -7914,6 +7943,7 @@ static void addEnumValuesToEnums(const Entry *root)
79147943
fmmd->setId(e->id);
79157944
fmmd->setDocumentation(e->doc,e->docFile,e->docLine);
79167945
fmmd->setBriefDescription(e->brief,e->briefFile,e->briefLine);
7946+
fmmd->setIsTrivial(e->isTrivial || fmmd->isTrivial());
79177947
fmmd->addSectionsToDefinition(e->anchors);
79187948
fmmd->setInitializer(e->initializer.str());
79197949
fmmd->setMaxInitLines(e->initLines);
@@ -8028,6 +8058,7 @@ static void addEnumDocs(const Entry *root,MemberDefMutable *md)
80288058
{
80298059
md->setBriefDescription(root->brief,root->briefFile,root->briefLine);
80308060
}
8061+
md->setIsTrivial(root->isTrivial || md->isTrivial());
80318062

80328063
if (md->inbodyDocumentation().isEmpty() || !root->parent()->name.isEmpty())
80338064
{
@@ -9290,6 +9321,7 @@ static void inheritDocumentation()
92909321
md->setDocumentation(bmd->documentation(),bmd->docFile(),bmd->docLine());
92919322
md->setDocsForDefinition(bmd->isDocsForDefinition());
92929323
md->setBriefDescription(bmd->briefDescription(),bmd->briefFile(),bmd->briefLine());
9324+
md->setIsTrivial(bmd->isTrivial() || md->isTrivial());
92939325
md->copyArgumentNames(bmd);
92949326
md->setInbodyDocumentation(bmd->inbodyDocumentation(),bmd->inbodyFile(),bmd->inbodyLine());
92959327
}
@@ -9589,6 +9621,7 @@ static void addDefineDoc(const Entry *root, MemberDefMutable *md)
95899621
md->setDocumentation(root->doc,root->docFile,root->docLine);
95909622
md->setDocsForDefinition(!root->proto);
95919623
md->setBriefDescription(root->brief,root->briefFile,root->briefLine);
9624+
md->setIsTrivial(root->isTrivial || md->isTrivial());
95929625
if (md->inbodyDocumentation().isEmpty())
95939626
{
95949627
md->setInbodyDocumentation(root->inbodyDocs,root->inbodyFile,root->inbodyLine);

‎src/memberdef.cpp‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6261,6 +6261,8 @@ void combineDeclarationAndDefinition(MemberDefMutable *mdec,MemberDefMutable *md
62616261
{
62626262
mdec->setBriefDescription(mdef->briefDescription(),mdef->briefFile(),mdef->briefLine());
62636263
}
6264+
mdef->setIsTrivial(mdec->isTrivial() || mdef->isTrivial());
6265+
mdec->setIsTrivial(mdef->isTrivial());
62646266
if (!mdef->documentation().isEmpty())
62656267
{
62666268
//printf("transferring docs mdef->mdec (%s->%s)\n",mdef->argsString(),mdec->argsString());

‎src/membergroup.cpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,7 @@ void MemberGroup::distributeMemberGroupDocumentation()
236236
{
237237
//printf("Copying documentation to member %s\n",qPrint(omd->name()));
238238
omd->setBriefDescription(md->briefDescription(),md->briefFile(),md->briefLine());
239+
omd->setIsTrivial(md->isTrivial() || omd->isTrivial());
239240
omd->setDocumentation(md->documentation(),md->docFile(),md->docLine());
240241
omd->setInbodyDocumentation(md->inbodyDocumentation(),md->inbodyFile(),md->inbodyLine());
241242
}

‎src/vhdldocgen.cpp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2265,6 +2265,7 @@ static void addInstance(ClassDefMutable* classEntity, ClassDefMutable* ar,
22652265
mmd->setLanguage(SrcLangExt::VHDL);
22662266
mmd->setVhdlSpecifiers(VhdlSpecifier::INSTANTIATION);
22672267
mmd->setBriefDescription(cur->brief,cur->briefFile,cur->briefLine);
2268+
mmd->setIsTrivial(cur->isTrivial || mmd->isTrivial());
22682269
mmd->setBodySegment(cur->startLine,cur->startLine,-1) ;
22692270
mmd->setDocumentation(cur->doc,cur->docFile,cur->docLine);
22702271
FileDef *fd=ar->getFileDef();

0 commit comments

Comments
 (0)