Skip to main content

The ConceptDefImpl Class Reference

Declaration​

class ConceptDefImpl { ... }

Base class​

classDefinitionMixin<Base>

Public Constructors Index​

ConceptDefImpl (const QCString &fileName, int startLine, int startColumn, const QCString &name, const QCString &tagRef=QCString(), const QCString &tagFile=QCString())

Public Destructor Index​

~ConceptDefImpl () override

Public Member Functions Index​

DefTypedefinitionType () const override
CodeSymbolTypecodeSymbolType () const override
QCStringgetOutputFileBase () const override
boolhasDetailedDescription () const override
QCStringdisplayName (bool includeScope=true) const override
const IncludeInfo *includeInfo () const override
ArgumentListgetTemplateParameterList () const override
QCStringanchor () const override
boolisLinkableInProject () const override
boolisLinkable () const override
QCStringinitializer () const override
voidwriteDeclarationLink (OutputList &ol, bool &found, const QCString &header, bool localNames) const override
const NamespaceDef *getNamespaceDef () const override
const FileDef *getFileDef () const override
const ModuleDef *getModuleDef () const override
QCStringtitle () const override
intgroupId () const override
voidsetIncludeFile (FileDef *fd, const QCString &incName, bool local, bool force) override
voidsetTemplateArguments (const ArgumentList &al) override
voidsetNamespace (NamespaceDef *nd) override
voidsetFileDef (FileDef *fd) override
voidsetModuleDef (ModuleDef *mod) override
voidwriteTagFile (TextStream &) override
voidwriteDocumentation (OutputList &) override
voidsetInitializer (const QCString &init) override
voidfindSectionsInDocumentation () override
voidsetGroupId (int id) override
voidwriteBriefDescription (OutputList &) const
voidwriteAuthorSection (OutputList &ol) const
voidwriteIncludeFiles (OutputList &ol) const
voidwriteDetailedDescription (OutputList &ol, const QCString &title) const
voidwriteDefinition (OutputList &ol, const QCString &title) const
voidaddConceptAttributes (OutputList &ol) const

Private Member Attributes Index​

QCStringm_fileName
std::unique_ptr< IncludeInfo >m_incInfo
NamespaceDef *m_nspace = nullptr
FileDef *m_fileDef = nullptr
ModuleDef *m_moduleDef = nullptr
ArgumentListm_tArgList
QCStringm_initializer
intm_groupId = -1

Definition at line 31 of file conceptdef.cpp.

Public Constructors​

ConceptDefImpl()​

ConceptDefImpl::ConceptDefImpl (const QCString & fileName, int startLine, int startColumn, const QCString & name, const QCString & tagRef=QCString(), const QCString & tagFile=QCString())

Definition at line 34 of file conceptdef.cpp.

156ConceptDefImpl::ConceptDefImpl(const QCString &fileName,int startLine,int startColumn,
157 const QCString &name,const QCString &tagRef,const QCString &tagFile) : DefinitionMixin(fileName,startLine,startColumn,name)
158{
159 if (!tagFile.isEmpty())
160 {
161 if (!tagRef.isEmpty())
162 {
163 m_fileName = stripExtension(tagFile);
164 }
165 else
166 {
167 m_fileName = convertNameToFile(stripExtension(tagFile));
168 }
169 }
170 else
171 {
172 m_fileName = convertNameToFile(QCString("concept")+name);
173 }
174 setReference(tagRef);
175}

References DefinitionMixin< ConceptDefMutable >::DefinitionMixin, QCString::isEmpty and DefinitionMixin< ConceptDefMutable >::name.

Public Destructor​

~ConceptDefImpl()​

ConceptDefImpl::~ConceptDefImpl ()

Definition at line 36 of file conceptdef.cpp.

177ConceptDefImpl::~ConceptDefImpl()
178{
179}

Public Member Functions​

addConceptAttributes()​

void ConceptDefImpl::addConceptAttributes (OutputList & ol)

Definition at line 77 of file conceptdef.cpp.

507void ConceptDefImpl::addConceptAttributes(OutputList &ol) const
508{
509 if (isExported())
510 {
511 ol.pushGeneratorState();
512 ol.disableAllBut(OutputType::Html);
513 ol.startLabels();
514 ol.writeLabel("export",false);
515 ol.endLabels();
516 ol.popGeneratorState();
517 }
518}

References OutputList::disableAllBut, OutputList::endLabels, Html, DefinitionMixin< ConceptDefMutable >::isExported, OutputList::popGeneratorState, OutputList::pushGeneratorState, OutputList::startLabels and OutputList::writeLabel.

Referenced by writeDocumentation.

anchor()​

QCString ConceptDefImpl::anchor ()
 virtual

Returns the anchor within a page where this item can be found

Definition at line 47 of file conceptdef.cpp.

200QCString ConceptDefImpl::anchor() const
201{
202 return "";
203}

Referenced by writeDeclarationLink.

codeSymbolType()​

CodeSymbolType ConceptDefImpl::codeSymbolType ()
 inline virtual

Used for syntax highlighting symbol class

Definition at line 41 of file conceptdef.cpp.

41 CodeSymbolType codeSymbolType() const override { return CodeSymbolType::Concept; }

Reference Concept.

definitionType()​

Definition::DefType ConceptDefImpl::definitionType ()
 virtual

Use this for dynamic inspection of the type of the derived class

Definition at line 40 of file conceptdef.cpp.

181Definition::DefType ConceptDefImpl::definitionType() const
182{
183 return TypeConcept;
184}

Reference Definition::TypeConcept.

displayName()​

QCString ConceptDefImpl::displayName (bool includeScope=true)
 virtual

Returns the name of the definition as it appears in the output

Definition at line 44 of file conceptdef.cpp.

205QCString ConceptDefImpl::displayName(bool includeScope) const
206{
207 return includeScope ? name() : localName();
208}

References DefinitionMixin< ConceptDefMutable >::localName and DefinitionMixin< ConceptDefMutable >::name.

Referenced by title, writeDeclarationLink and writeDocumentation.

findSectionsInDocumentation()​

void ConceptDefImpl::findSectionsInDocumentation ()
 virtual

Definition at line 68 of file conceptdef.cpp.

700void ConceptDefImpl::findSectionsInDocumentation()
701{
702 docFindSections(briefDescription(),this,docFile());
703 docFindSections(documentation(),this,docFile());
704 docFindSections(inbodyDocumentation(),this,docFile());
705}

References DefinitionMixin< ConceptDefMutable >::briefDescription, DefinitionMixin< ConceptDefMutable >::docFile, docFindSections, DefinitionMixin< ConceptDefMutable >::documentation and DefinitionMixin< ConceptDefMutable >::inbodyDocumentation.

getFileDef()​

const FileDef * ConceptDefImpl::getFileDef ()
 virtual

Definition at line 54 of file conceptdef.cpp.

276const FileDef *ConceptDefImpl::getFileDef() const
277{
278 return m_fileDef;
279}

Reference m_fileDef.

getModuleDef()​

const ModuleDef * ConceptDefImpl::getModuleDef ()
 virtual

Definition at line 55 of file conceptdef.cpp.

281const ModuleDef *ConceptDefImpl::getModuleDef() const
282{
283 return m_moduleDef;
284}

Reference m_moduleDef.

getNamespaceDef()​

const NamespaceDef * ConceptDefImpl::getNamespaceDef ()
 virtual

Definition at line 53 of file conceptdef.cpp.

261const NamespaceDef *ConceptDefImpl::getNamespaceDef() const
262{
263 return m_nspace;
264}

Reference m_nspace.

getOutputFileBase()​

QCString ConceptDefImpl::getOutputFileBase ()
 virtual

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Definition at line 42 of file conceptdef.cpp.

186QCString ConceptDefImpl::getOutputFileBase() const
187{
188 return m_fileName;
189}

Reference m_fileName.

Referenced by writeBriefDescription, writeDeclarationLink, writeDocumentation and writeTagFile.

getTemplateParameterList()​

ArgumentList ConceptDefImpl::getTemplateParameterList ()
 virtual

Definition at line 46 of file conceptdef.cpp.

215ArgumentList ConceptDefImpl::getTemplateParameterList() const
216{
217 return m_tArgList;
218}

Reference m_tArgList.

groupId()​

int ConceptDefImpl::groupId ()
 virtual

Definition at line 57 of file conceptdef.cpp.

298int ConceptDefImpl::groupId() const
299{
300 return m_groupId;
301}

Reference m_groupId.

hasDetailedDescription()​

bool ConceptDefImpl::hasDetailedDescription ()
 virtual

Definition at line 43 of file conceptdef.cpp.

191bool ConceptDefImpl::hasDetailedDescription() const
192{
193 bool repeatBrief = Config_getBool(REPEAT_BRIEF);
194 bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
195 return ((!briefDescription().isEmpty() && repeatBrief) ||
196 !documentation().isEmpty() ||
197 (sourceBrowser && getStartBodyLine()!=-1 && getBodyDef()));
198}

References DefinitionMixin< ConceptDefMutable >::briefDescription, Config_getBool, DefinitionMixin< ConceptDefMutable >::documentation, DefinitionMixin< ConceptDefMutable >::getBodyDef and DefinitionMixin< ConceptDefMutable >::getStartBodyLine.

Referenced by writeBriefDescription and writeDetailedDescription.

includeInfo()​

const IncludeInfo * ConceptDefImpl::includeInfo ()
 virtual

Definition at line 45 of file conceptdef.cpp.

210const IncludeInfo *ConceptDefImpl::includeInfo() const
211{
212 return m_incInfo.get();
213}

Reference m_incInfo.

initializer()​

QCString ConceptDefImpl::initializer ()
 virtual

Definition at line 50 of file conceptdef.cpp.

424QCString ConceptDefImpl::initializer() const
425{
426 return m_initializer;
427}

Reference m_initializer.

isLinkable()​

bool ConceptDefImpl::isLinkable ()
 virtual

Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.

Definition at line 49 of file conceptdef.cpp.

228bool ConceptDefImpl::isLinkable() const
229{
230 return isLinkableInProject() || isReference();
231}

References isLinkableInProject and DefinitionMixin< ConceptDefMutable >::isReference.

Referenced by writeDeclarationLink.

isLinkableInProject()​

bool ConceptDefImpl::isLinkableInProject ()
 virtual

Returns TRUE iff it is possible to link to this item within this project.

Definition at line 48 of file conceptdef.cpp.

220bool ConceptDefImpl::isLinkableInProject() const
221{
222 bool hideUndoc = Config_getBool(HIDE_UNDOC_CLASSES);
223 return (hasDocumentation() || !hideUndoc) && /* documented */
224 !isHidden() && /* not hidden */
225 !isReference(); /* not an external reference */
226}

References Config_getBool, DefinitionMixin< ConceptDefMutable >::hasDocumentation, DefinitionMixin< ConceptDefMutable >::isHidden and DefinitionMixin< ConceptDefMutable >::isReference.

Referenced by isLinkable.

setFileDef()​

void ConceptDefImpl::setFileDef (FileDef * fd)
 virtual

Definition at line 63 of file conceptdef.cpp.

266void ConceptDefImpl::setFileDef(FileDef *fd)
267{
268 m_fileDef=fd;
269}

Reference m_fileDef.

setGroupId()​

void ConceptDefImpl::setGroupId (int id)
 virtual

Definition at line 69 of file conceptdef.cpp.

303void ConceptDefImpl::setGroupId(int id)
304{
305 m_groupId = id;
306}

References DefinitionMixin< ConceptDefMutable >::id and m_groupId.

setIncludeFile()​

void ConceptDefImpl::setIncludeFile (FileDef * fd, const QCString & incName, bool local, bool force)
 virtual

Definition at line 60 of file conceptdef.cpp.

233void ConceptDefImpl::setIncludeFile(FileDef *fd,const QCString &incName,bool local,bool force)
234{
235 if (!m_incInfo) m_incInfo = std::make_unique<IncludeInfo>();
236 if ((!incName.isEmpty() && m_incInfo->includeName.isEmpty()) ||
237 (fd!=nullptr && m_incInfo->fileDef==nullptr)
238 )
239 {
240 m_incInfo->fileDef = fd;
241 m_incInfo->includeName = incName;
242 m_incInfo->kind = local ? IncludeKind::IncludeLocal : IncludeKind::IncludeSystem;
243 }
244 if (force && !incName.isEmpty())
245 {
246 m_incInfo->includeName = incName;
247 m_incInfo->kind = local ? IncludeKind::IncludeLocal : IncludeKind::IncludeSystem;
248 }
249}

References IncludeLocal, IncludeSystem, QCString::isEmpty and m_incInfo.

setInitializer()​

void ConceptDefImpl::setInitializer (const QCString & init)
 virtual

Definition at line 67 of file conceptdef.cpp.

419void ConceptDefImpl::setInitializer(const QCString &init)
420{
421 m_initializer = templateSpec(m_tArgList)+"\nconcept "+name()+" = "+init;
422}

References m_initializer, m_tArgList, DefinitionMixin< ConceptDefMutable >::name and templateSpec.

setModuleDef()​

void ConceptDefImpl::setModuleDef (ModuleDef * mod)
 virtual

Definition at line 64 of file conceptdef.cpp.

271void ConceptDefImpl::setModuleDef(ModuleDef *mod)
272{
273 m_moduleDef=mod;
274}

Reference m_moduleDef.

setNamespace()​

void ConceptDefImpl::setNamespace (NamespaceDef * nd)
 virtual

Definition at line 62 of file conceptdef.cpp.

256void ConceptDefImpl::setNamespace(NamespaceDef *nd)
257{
258 m_nspace = nd;
259}

Reference m_nspace.

setTemplateArguments()​

void ConceptDefImpl::setTemplateArguments (const ArgumentList & al)
 virtual

Definition at line 61 of file conceptdef.cpp.

251void ConceptDefImpl::setTemplateArguments(const ArgumentList &al)
252{
253 m_tArgList = al;
254}

Reference m_tArgList.

title()​

QCString ConceptDefImpl::title ()
 virtual

Definition at line 56 of file conceptdef.cpp.

286QCString ConceptDefImpl::title() const
287{
288 if (Config_getBool(HIDE_COMPOUND_REFERENCE))
289 {
290 return displayName();
291 }
292 else
293 {
294 return theTranslator->trConceptReference(displayName());
295 }
296}

References Config_getBool, displayName and theTranslator.

Referenced by writeDefinition and writeDetailedDescription.

writeAuthorSection()​

void ConceptDefImpl::writeAuthorSection (OutputList & ol)

Definition at line 73 of file conceptdef.cpp.

495void ConceptDefImpl::writeAuthorSection(OutputList &ol) const
496{
497 // write Author section (Man only)
498 ol.pushGeneratorState();
499 ol.disableAllBut(OutputType::Man);
500 ol.startGroupHeader();
501 ol.parseText(theTranslator->trAuthor(TRUE,TRUE));
502 ol.endGroupHeader();
503 ol.parseText(theTranslator->trGeneratedAutomatically(Config_getString(PROJECT_NAME)));
504 ol.popGeneratorState();
505}

References Config_getString, OutputList::disableAllBut, OutputList::endGroupHeader, Man, OutputList::parseText, OutputList::popGeneratorState, OutputList::pushGeneratorState, OutputList::startGroupHeader, theTranslator and TRUE.

Referenced by writeDocumentation.

writeBriefDescription()​

void ConceptDefImpl::writeBriefDescription (OutputList & ol)

Definition at line 72 of file conceptdef.cpp.

324void ConceptDefImpl::writeBriefDescription(OutputList &ol) const
325{
326 if (hasBriefDescription())
327 {
328 auto parser { createDocParser() };
329 auto ast { validatingParseDoc(
330 *parser.get(),briefFile(),briefLine(),this,nullptr,
331 briefDescription(),TRUE,FALSE,
332 QCString(),TRUE,FALSE) };
333 if (!ast->isEmpty())
334 {
335 ol.startParagraph();
336 ol.pushGeneratorState();
337 ol.disableAllBut(OutputType::Man);
338 ol.writeString(" - ");
339 ol.popGeneratorState();
340 ol.writeDoc(ast.get(),this,nullptr);
341 ol.pushGeneratorState();
342 ol.disable(OutputType::RTF);
343 ol.writeString(" \n");
344 ol.enable(OutputType::RTF);
345
346 if (hasDetailedDescription())
347 {
348 ol.disableAllBut(OutputType::Html);
349 ol.startTextLink(getOutputFileBase(),"details");
350 ol.parseText(theTranslator->trMore());
351 ol.endTextLink();
352 }
353 ol.popGeneratorState();
354 ol.endParagraph();
355 }
356 }
357 ol.writeSynopsis();
358}

References DefinitionMixin< ConceptDefMutable >::briefDescription, DefinitionMixin< ConceptDefMutable >::briefFile, DefinitionMixin< ConceptDefMutable >::briefLine, createDocParser, OutputList::disable, OutputList::disableAllBut, OutputList::enable, OutputList::endParagraph, OutputList::endTextLink, FALSE, getOutputFileBase, DefinitionMixin< ConceptDefMutable >::hasBriefDescription, hasDetailedDescription, Html, Man, OutputList::parseText, OutputList::popGeneratorState, OutputList::pushGeneratorState, RTF, OutputList::startParagraph, OutputList::startTextLink, theTranslator, TRUE, validatingParseDoc, OutputList::writeDoc, OutputList::writeString and OutputList::writeSynopsis.

Referenced by writeDocumentation.

writeDeclarationLink()​

void ConceptDefImpl::writeDeclarationLink (OutputList & ol, bool & found, const QCString & header, bool localNames)
 virtual

Definition at line 51 of file conceptdef.cpp.

640void ConceptDefImpl::writeDeclarationLink(OutputList &ol,bool &found,const QCString &header,bool localNames) const
641{
642 if (isLinkable())
643 {
644 if (!found) // first concept
645 {
646 ol.startMemberHeader("concepts");
647 if (!header.isEmpty())
648 {
649 ol.parseText(header);
650 }
651 else
652 {
653 theTranslator->trConcept(true,false);
654 }
655 ol.endMemberHeader();
656 ol.startMemberList();
657 found=TRUE;
658 }
659 ol.startMemberDeclaration();
660 QCString cname = displayName(!localNames);
661 QCString anc=anchor();
662 if (anc.isEmpty()) anc=cname; else anc.prepend(cname+"_");
663 ol.startMemberItem(anc,OutputGenerator::MemberItemType::Normal);
664 ol.writeString("concept ");
665 ol.insertMemberAlign();
666 if (isLinkable())
667 {
668 ol.writeObjectLink(getReference(),
669 getOutputFileBase(),
670 anchor(),
671 cname
672 );
673 }
674 else
675 {
676 ol.startBold();
677 ol.docify(cname);
678 ol.endBold();
679 }
680 ol.endMemberItem(OutputGenerator::MemberItemType::Normal);
681 // add the brief description if available
682 if (!briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
683 {
684 auto parser { createDocParser() };
685 auto ast { validatingParseDoc(
686 *parser.get(),briefFile(),briefLine(),this,nullptr,
687 briefDescription(),FALSE,FALSE,
688 QCString(),TRUE,FALSE) };
689 if (!ast->isEmpty())
690 {
691 ol.startMemberDescription(anchor());
692 ol.writeDoc(ast.get(),this,nullptr);
693 ol.endMemberDescription();
694 }
695 }
696 ol.endMemberDeclaration(anchor(),QCString());
697 }
698}

References anchor, DefinitionMixin< ConceptDefMutable >::briefDescription, DefinitionMixin< ConceptDefMutable >::briefFile, DefinitionMixin< ConceptDefMutable >::briefLine, Config_getBool, createDocParser, displayName, OutputList::docify, OutputList::endBold, OutputList::endMemberDeclaration, OutputList::endMemberDescription, OutputList::endMemberHeader, OutputList::endMemberItem, FALSE, getOutputFileBase, DefinitionMixin< ConceptDefMutable >::getReference, OutputList::insertMemberAlign, QCString::isEmpty, isLinkable, OutputGenerator::Normal, OutputList::parseText, QCString::prepend, OutputList::startBold, OutputList::startMemberDeclaration, OutputList::startMemberDescription, OutputList::startMemberHeader, OutputList::startMemberItem, OutputList::startMemberList, theTranslator, TRUE, validatingParseDoc, OutputList::writeDoc, OutputList::writeObjectLink and OutputList::writeString.

writeDefinition()​

void ConceptDefImpl::writeDefinition (OutputList & ol, const QCString & title)

Definition at line 76 of file conceptdef.cpp.

429void ConceptDefImpl::writeDefinition(OutputList &ol,const QCString &title) const
430{
431 ol.startGroupHeader("conceptdef");
432 ol.parseText(title);
433 ol.endGroupHeader();
434
435 auto intf = Doxygen::parserManager->getCodeParser(".cpp");
436 intf->resetCodeParserState();
437 auto &codeOL = ol.codeGenerators();
438 codeOL.startCodeFragment("DoxyCode");
439 QCString scopeName;
440 if (getOuterScope()!=Doxygen::globalScope) scopeName=getOuterScope()->name();
441 TextStream conceptDef;
442 conceptDef << m_initializer;
443 intf->parseCode(codeOL,scopeName,conceptDef.str(),SrcLangExt::Cpp,Config_getBool(STRIP_CODE_COMMENTS),false,QCString(),
444 m_fileDef, -1,-1,true,nullptr,false,this);
445 codeOL.endCodeFragment("DoxyCode");
446}

References OutputList::codeGenerators, Config_getBool, OutputList::endGroupHeader, DefinitionMixin< ConceptDefMutable >::getOuterScope, Doxygen::globalScope, m_fileDef, m_initializer, Definition::name, Doxygen::parserManager, OutputList::parseText, OutputCodeList::startCodeFragment, OutputList::startGroupHeader, TextStream::str and title.

Referenced by writeDocumentation.

writeDetailedDescription()​

void ConceptDefImpl::writeDetailedDescription (OutputList & ol, const QCString & title)

Definition at line 75 of file conceptdef.cpp.

448void ConceptDefImpl::writeDetailedDescription(OutputList &ol,const QCString &title) const
449{
450 bool repeatBrief = Config_getBool(REPEAT_BRIEF);
451 if (hasDetailedDescription())
452 {
453 ol.pushGeneratorState();
454 ol.disable(OutputType::Html);
455 ol.writeRuler();
456 ol.popGeneratorState();
457
458 ol.pushGeneratorState();
459 ol.disableAllBut(OutputType::Html);
460 ol.writeAnchor(QCString(),"details");
461 ol.popGeneratorState();
462
463 ol.startGroupHeader("details");
464 ol.parseText(title);
465 ol.endGroupHeader();
466
467 ol.startTextBlock();
468 // repeat brief description
469 if (!briefDescription().isEmpty() && repeatBrief)
470 {
471 ol.generateDoc(briefFile(),briefLine(),this,nullptr,briefDescription(),FALSE,FALSE,
472 QCString(),FALSE,FALSE);
473 }
474 if (!briefDescription().isEmpty() && repeatBrief &&
475 !documentation().isEmpty())
476 {
477 ol.pushGeneratorState();
478 ol.disable(OutputType::Html);
479 ol.writeString("\n\n");
480 ol.popGeneratorState();
481 }
482
483 // write documentation
484 if (!documentation().isEmpty())
485 {
486 ol.generateDoc(docFile(),docLine(),this,nullptr,documentation(),TRUE,FALSE,
487 QCString(),FALSE,FALSE);
488 }
489
490 writeSourceDef(ol);
491 ol.endTextBlock();
492 }
493}

References DefinitionMixin< ConceptDefMutable >::briefDescription, DefinitionMixin< ConceptDefMutable >::briefFile, DefinitionMixin< ConceptDefMutable >::briefLine, Config_getBool, OutputList::disable, OutputList::disableAllBut, DefinitionMixin< ConceptDefMutable >::docFile, DefinitionMixin< ConceptDefMutable >::docLine, DefinitionMixin< ConceptDefMutable >::documentation, OutputList::endGroupHeader, OutputList::endTextBlock, FALSE, OutputList::generateDoc, hasDetailedDescription, Html, OutputList::parseText, OutputList::popGeneratorState, OutputList::pushGeneratorState, OutputList::startGroupHeader, OutputList::startTextBlock, title, TRUE, OutputList::writeAnchor, OutputList::writeRuler, DefinitionMixin< ConceptDefMutable >::writeSourceDef and OutputList::writeString.

Referenced by writeDocumentation.

writeDocumentation()​

void ConceptDefImpl::writeDocumentation (OutputList & ol)
 virtual

Definition at line 66 of file conceptdef.cpp.

520void ConceptDefImpl::writeDocumentation(OutputList &ol)
521{
522 bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
523 QCString pageTitle;
524 if (Config_getBool(HIDE_COMPOUND_REFERENCE))
525 {
526 pageTitle = displayName();
527 }
528 else
529 {
530 pageTitle = theTranslator->trConceptReference(displayName());
531 }
532 startFile(ol,getOutputFileBase(),name(),pageTitle,HighlightedItem::ConceptVisible,!generateTreeView);
533
534 // ---- navigation part
535 if (!generateTreeView)
536 {
537 if (getOuterScope()!=Doxygen::globalScope)
538 {
539 writeNavigationPath(ol);
540 }
541 ol.endQuickIndices();
542 }
543
544 // ---- title part
545 startTitle(ol,getOutputFileBase(),this);
546 ol.parseText(pageTitle);
547 addConceptAttributes(ol);
548 addGroupListToTitle(ol,this);
549 endTitle(ol,getOutputFileBase(),displayName());
550
551 // ---- contents part
552
553 ol.startContents();
554
555 //---------------------------------------- start flexible part -------------------------------
556
557 for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Concept))
558 {
559 const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
560 switch (lde->kind())
561 {
562 case LayoutDocEntry::BriefDesc:
563 writeBriefDescription(ol);
564 break;
565 case LayoutDocEntry::ConceptDefinition:
566 if (ls) writeDefinition(ol,ls->title(getLanguage()));
567 break;
568 case LayoutDocEntry::DetailedDesc:
569 if (ls) writeDetailedDescription(ol,ls->title(getLanguage()));
570 break;
571 case LayoutDocEntry::AuthorSection:
572 writeAuthorSection(ol);
573 break;
574 case LayoutDocEntry::ClassIncludes:
575 writeIncludeFiles(ol);
576 break;
577 case LayoutDocEntry::MemberDeclStart:
578 case LayoutDocEntry::NamespaceClasses:
579 case LayoutDocEntry::NamespaceInterfaces:
580 case LayoutDocEntry::NamespaceStructs:
581 case LayoutDocEntry::NamespaceExceptions:
582 case LayoutDocEntry::NamespaceConcepts:
583 case LayoutDocEntry::NamespaceNestedNamespaces:
584 case LayoutDocEntry::NamespaceNestedConstantGroups:
585 case LayoutDocEntry::MemberGroups:
586 case LayoutDocEntry::MemberDecl:
587 case LayoutDocEntry::MemberDeclEnd:
588 case LayoutDocEntry::MemberDefStart:
589 case LayoutDocEntry::NamespaceInlineClasses:
590 case LayoutDocEntry::MemberDef:
591 case LayoutDocEntry::MemberDefEnd:
592 case LayoutDocEntry::ClassInheritanceGraph:
593 case LayoutDocEntry::ClassNestedClasses:
594 case LayoutDocEntry::ClassCollaborationGraph:
595 case LayoutDocEntry::ClassAllMembersLink:
596 case LayoutDocEntry::ClassUsedFiles:
597 case LayoutDocEntry::ClassInlineClasses:
598 case LayoutDocEntry::FileClasses:
599 case LayoutDocEntry::FileConcepts:
600 case LayoutDocEntry::FileInterfaces:
601 case LayoutDocEntry::FileStructs:
602 case LayoutDocEntry::FileExceptions:
603 case LayoutDocEntry::FileNamespaces:
604 case LayoutDocEntry::FileConstantGroups:
605 case LayoutDocEntry::FileIncludes:
606 case LayoutDocEntry::FileIncludeGraph:
607 case LayoutDocEntry::FileIncludedByGraph:
608 case LayoutDocEntry::FileInlineClasses:
609 case LayoutDocEntry::FileSourceLink:
610 case LayoutDocEntry::GroupClasses:
611 case LayoutDocEntry::GroupConcepts:
612 case LayoutDocEntry::GroupModules:
613 case LayoutDocEntry::GroupInlineClasses:
614 case LayoutDocEntry::GroupNamespaces:
615 case LayoutDocEntry::GroupDirs:
616 case LayoutDocEntry::GroupNestedGroups:
617 case LayoutDocEntry::GroupFiles:
618 case LayoutDocEntry::GroupGraph:
619 case LayoutDocEntry::GroupPageDocs:
620 case LayoutDocEntry::ModuleExports:
621 case LayoutDocEntry::ModuleClasses:
622 case LayoutDocEntry::ModuleConcepts:
623 case LayoutDocEntry::ModuleUsedFiles:
624 case LayoutDocEntry::DirSubDirs:
625 case LayoutDocEntry::DirFiles:
626 case LayoutDocEntry::DirGraph:
627 err("Internal inconsistency: member '{}' should not be part of "
628 "LayoutDocManager::Concept entry list\n",lde->entryToString());
629 break;
630 }
631 }
632
633 //---------------------------------------- end flexible part -------------------------------
634
635 ol.endContents();
636
637 endFileWithNavPath(ol,this);
638}

References addConceptAttributes, addGroupListToTitle, ConceptVisible, Config_getBool, displayName, OutputList::endContents, endFileWithNavPath, OutputList::endQuickIndices, endTitle, err, DefinitionMixin< ConceptDefMutable >::getLanguage, DefinitionMixin< ConceptDefMutable >::getOuterScope, getOutputFileBase, Doxygen::globalScope, LayoutDocManager::instance, DefinitionMixin< ConceptDefMutable >::name, OutputList::parseText, OutputList::startContents, startFile, startTitle, theTranslator, LayoutDocEntrySection::title, writeAuthorSection, writeBriefDescription, writeDefinition, writeDetailedDescription, writeIncludeFiles and DefinitionMixin< ConceptDefMutable >::writeNavigationPath.

writeIncludeFiles()​

void ConceptDefImpl::writeIncludeFiles (OutputList & ol)

Definition at line 74 of file conceptdef.cpp.

360void ConceptDefImpl::writeIncludeFiles(OutputList &ol) const
361{
362 if (m_incInfo)
363 {
364 QCString nm=m_incInfo->includeName.isEmpty() ?
365 (m_incInfo->fileDef ?
366 m_incInfo->fileDef->docName() : QCString()
367 ) :
368 m_incInfo->includeName;
369 if (!nm.isEmpty())
370 {
371 ol.startParagraph();
372 ol.startTypewriter();
373 ol.docify(::includeStatement(SrcLangExt::Cpp,m_incInfo->kind));
374 ol.docify(::includeOpen(SrcLangExt::Cpp,m_incInfo->kind));
375 ol.pushGeneratorState();
376 ol.disable(OutputType::Html);
377 ol.docify(nm);
378 ol.disableAllBut(OutputType::Html);
379 ol.enable(OutputType::Html);
380 if (m_incInfo->fileDef)
381 {
382 ol.writeObjectLink(QCString(),m_incInfo->fileDef->includeName(),QCString(),nm);
383 }
384 else
385 {
386 ol.docify(nm);
387 }
388 ol.popGeneratorState();
389 ol.docify(::includeClose(SrcLangExt::Cpp,m_incInfo->kind));
390 ol.endTypewriter();
391 ol.endParagraph();
392 }
393 }
394}

References OutputList::disable, OutputList::disableAllBut, OutputList::docify, OutputList::enable, OutputList::endParagraph, OutputList::endTypewriter, Html, includeClose, includeOpen, includeStatement, QCString::isEmpty, m_incInfo, OutputList::popGeneratorState, OutputList::pushGeneratorState, OutputList::startParagraph, OutputList::startTypewriter and OutputList::writeObjectLink.

Referenced by writeDocumentation.

writeTagFile()​

void ConceptDefImpl::writeTagFile (TextStream & tagFile)
 virtual

Definition at line 65 of file conceptdef.cpp.

308void ConceptDefImpl::writeTagFile(TextStream &tagFile)
309{
310 tagFile << " <compound kind=\"concept\">\n";
311 tagFile << " <name>" << convertToXML(name()) << "</name>\n";
312 QCString fn = getOutputFileBase();
313 addHtmlExtensionIfMissing(fn);
314 tagFile << " <filename>" << convertToXML(fn) << "</filename>\n";
315 QCString idStr = id();
316 if (!idStr.isEmpty())
317 {
318 tagFile << " <clangid>" << convertToXML(idStr) << "</clangid>\n";
319 }
320 writeDocAnchorsToTagFile(tagFile);
321 tagFile << " </compound>\n";
322}

References addHtmlExtensionIfMissing, convertToXML, getOutputFileBase, DefinitionMixin< ConceptDefMutable >::id, QCString::isEmpty, DefinitionMixin< ConceptDefMutable >::name and DefinitionMixin< ConceptDefMutable >::writeDocAnchorsToTagFile.

Private Member Attributes​

m_fileDef​

FileDef* ConceptDefImpl::m_fileDef = nullptr

Definition at line 83 of file conceptdef.cpp.

83 FileDef *m_fileDef = nullptr;

Referenced by getFileDef, setFileDef and writeDefinition.

m_fileName​

QCString ConceptDefImpl::m_fileName

Definition at line 80 of file conceptdef.cpp.

80 QCString m_fileName;

Referenced by getOutputFileBase.

m_groupId​

int ConceptDefImpl::m_groupId = -1

Definition at line 87 of file conceptdef.cpp.

87 int m_groupId = -1;

Referenced by groupId and setGroupId.

m_incInfo​

std::unique_ptr<IncludeInfo> ConceptDefImpl::m_incInfo

Definition at line 81 of file conceptdef.cpp.

81 std::unique_ptr<IncludeInfo> m_incInfo;

Referenced by includeInfo, setIncludeFile and writeIncludeFiles.

m_initializer​

QCString ConceptDefImpl::m_initializer

Definition at line 86 of file conceptdef.cpp.

86 QCString m_initializer;

Referenced by initializer, setInitializer and writeDefinition.

m_moduleDef​

ModuleDef* ConceptDefImpl::m_moduleDef = nullptr

Definition at line 84 of file conceptdef.cpp.

84 ModuleDef *m_moduleDef = nullptr;

Referenced by getModuleDef and setModuleDef.

m_nspace​

NamespaceDef* ConceptDefImpl::m_nspace = nullptr

Definition at line 82 of file conceptdef.cpp.

82 NamespaceDef *m_nspace = nullptr;

Referenced by getNamespaceDef and setNamespace.

m_tArgList​

ArgumentList ConceptDefImpl::m_tArgList

Definition at line 85 of file conceptdef.cpp.

85 ArgumentList m_tArgList;

Referenced by getTemplateParameterList, setInitializer and setTemplateArguments.

The documentation for this class was generated from the following file:

Generated via doxygen2docusaurus by Doxygen 1.14.0.