Doxygen
Loading...
Searching...
No Matches
LayoutDocEntrySection Struct Referencefinal

#include <src/layout.h>

Inheritance diagram for LayoutDocEntrySection:
Collaboration diagram for LayoutDocEntrySection:

Public Member Functions

 LayoutDocEntrySection (Kind k, const std::string &id, const DString &tl, bool v)
DString title (SrcLangExt lang) const
Public Member Functions inherited from LayoutDocEntrySimple
 LayoutDocEntrySimple (Kind k, const std::string &id, bool v)
Kind kind () const override
bool visible () const override
std::string id () const override
Public Member Functions inherited from LayoutDocEntry
std::string entryToString () const

Private Attributes

DString m_title

Additional Inherited Members

Public Types inherited from LayoutDocEntry
enum  Kind { ENTRY_SPECIFICATIONS }

Detailed Description

Definition at line 100 of file layout.h.

Constructor & Destructor Documentation

◆ LayoutDocEntrySection()

LayoutDocEntrySection::LayoutDocEntrySection ( Kind k,
const std::string & id,
const DString & tl,
bool v )
inline

Definition at line 102 of file layout.h.

102 :
103 LayoutDocEntrySimple(k,id,v), m_title(tl) {}
LayoutDocEntrySection::m_title
DString m_title
Definition layout.h:106
LayoutDocEntrySimple::LayoutDocEntrySimple
LayoutDocEntrySimple(Kind k, const std::string &id, bool v)
Definition layout.h:90

References LayoutDocEntrySimple::id(), LayoutDocEntrySimple::LayoutDocEntrySimple(), and m_title.

Member Function Documentation

◆ title()

DString LayoutDocEntrySection::title ( SrcLangExt lang) const

Definition at line 1780 of file layout.cpp.

1781{
1782 return extractLanguageSpecificTitle(m_title,lang);
1783}
extractLanguageSpecificTitle
DString extractLanguageSpecificTitle(const DString &input, SrcLangExt lang)
Definition layout.cpp:1757

References extractLanguageSpecificTitle(), and m_title.

Referenced by ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), ModuleDefImpl::writeDocumentation(), NamespaceDefImpl::writeDocumentation(), ClassDefImpl::writeDocumentationContents(), ClassDefImpl::writeSummaryLinks(), FileDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ModuleDefImpl::writeSummaryLinks(), and NamespaceDefImpl::writeSummaryLinks().

Member Data Documentation

◆ m_title

DString LayoutDocEntrySection::m_title
private

Definition at line 106 of file layout.h.

Referenced by LayoutDocEntrySection(), and title().

The documentation for this struct was generated from the following files: