The LayoutDocEntryMemberDecl Struct Reference

Represents of a member declaration list with configurable title and subtitle. More...

Declaration

struct LayoutDocEntryMemberDecl { ... }

Included Headers

#include <src/layout.h>

Base struct

struct	LayoutDocEntry
	Base class representing a piece of a documentation page. More...

Public Constructors Index

	LayoutDocEntryMemberDecl (MemberListType tp, const std::string &id, const QCString &tl, const QCString &ss, bool v)

Public Member Functions Index

Kind	kind () const override
QCString	title (SrcLangExt lang) const
QCString	subtitle (SrcLangExt lang) const
bool	visible () const override
std::string	id () const override

Public Member Attributes Index

MemberListType	type

Private Member Attributes Index

std::string	m_id
QCString	m_title
QCString	m_subscript
bool	m_visible

Description

Represents of a member declaration list with configurable title and subtitle.

Definition at line 111 of file layout.h.

Public Constructors

LayoutDocEntryMemberDecl()

LayoutDocEntryMemberDecl::LayoutDocEntryMemberDecl (MemberListType tp, const std::string & id, const QCString & tl, const QCString & ss, bool v)

inline

Definition at line 113 of file layout.h.

113 LayoutDocEntryMemberDecl(MemberListType tp,const std::string &id,

114 const QCString &tl,const QCString &ss, bool v)

115 : type(tp), m_id(id), m_title(tl), m_subscript(ss), m_visible(v) {}

References id, m_id, m_subscript, m_title, m_visible and type.

Public Member Functions

id()

std::string LayoutDocEntryMemberDecl::id ()

inline virtual

Definition at line 122 of file layout.h.

122 std::string id() const override { return m_id; }

Reference m_id.

Referenced by LayoutDocEntryMemberDecl.

kind()

Kind LayoutDocEntryMemberDecl::kind ()

inline virtual

Definition at line 117 of file layout.h.

117 Kind kind() const override { return MemberDecl; }

subtitle()

QCString LayoutDocEntryMemberDecl::subtitle (SrcLangExt lang)

Declaration at line 120 of file layout.h, definition at line 1791 of file layout.cpp.

1791QCString LayoutDocEntryMemberDecl::subtitle(SrcLangExt lang) const

1792{

1793 return extractLanguageSpecificTitle(m_subscript,lang);

1794}

References extractLanguageSpecificTitle and m_subscript.

Referenced by ClassDefImpl::getTitleForMemberListType, ClassDefImpl::writeDocumentationContents and ClassDefImpl::writeInlineDocumentation.

title()

QCString LayoutDocEntryMemberDecl::title (SrcLangExt lang)

Declaration at line 119 of file layout.h, definition at line 1786 of file layout.cpp.

1786QCString LayoutDocEntryMemberDecl::title(SrcLangExt lang) const

1787{

1788 return extractLanguageSpecificTitle(m_title,lang);

1789}

References extractLanguageSpecificTitle and m_title.

Referenced by ClassDefImpl::getTitleForMemberListType, ClassDefImpl::writeAdditionalInheritedMembers, FileDefImpl::writeDocumentation, GroupDefImpl::writeDocumentation, ModuleDefImpl::writeDocumentation, NamespaceDefImpl::writeDocumentation, ClassDefImpl::writeDocumentationContents, ClassDefImpl::writeInlineDocumentation, ClassDefImpl::writeSummaryLinks, FileDefImpl::writeSummaryLinks, GroupDefImpl::writeSummaryLinks, ModuleDefImpl::writeSummaryLinks and NamespaceDefImpl::writeSummaryLinks.

visible()

bool LayoutDocEntryMemberDecl::visible ()

inline virtual

Definition at line 121 of file layout.h.

121 bool visible() const override { return m_visible; }

Reference m_visible.

Referenced by ModuleDefImpl::writeTagFile.

Public Member Attributes

type

MemberListType LayoutDocEntryMemberDecl::type

Definition at line 118 of file layout.h.

118 MemberListType type;

Referenced by ClassDefImpl::countAdditionalInheritedMembers, ModuleDefImpl::countVisibleMembers, ClassDefImpl::getTitleForMemberListType, LayoutDocEntryMemberDecl, ClassDefImpl::setAnonymousEnumType, ClassDefImpl::writeAdditionalInheritedMembers, ClassDefImpl::writeDeclaration, FileDefImpl::writeDocumentation, GroupDefImpl::writeDocumentation, ModuleDefImpl::writeDocumentation, NamespaceDefImpl::writeDocumentation, ClassDefImpl::writeDocumentationContents, ClassDefImpl::writeInlineDocumentation, writeModuleMembers, ClassDefImpl::writeSummaryLinks, FileDefImpl::writeSummaryLinks, GroupDefImpl::writeSummaryLinks, ModuleDefImpl::writeSummaryLinks, NamespaceDefImpl::writeSummaryLinks, ClassDefImpl::writeTagFile, FileDefImpl::writeTagFile, GroupDefImpl::writeTagFile, ModuleDefImpl::writeTagFile and NamespaceDefImpl::writeTagFile.

Private Member Attributes

m_id

std::string LayoutDocEntryMemberDecl::m_id

Definition at line 124 of file layout.h.

124 std::string m_id;

Referenced by id and LayoutDocEntryMemberDecl.

m_subscript

QCString LayoutDocEntryMemberDecl::m_subscript

Definition at line 126 of file layout.h.

126 QCString m_subscript;

Referenced by LayoutDocEntryMemberDecl and subtitle.

m_title

QCString LayoutDocEntryMemberDecl::m_title

Definition at line 125 of file layout.h.

125 QCString m_title;

Referenced by LayoutDocEntryMemberDecl and title.

m_visible

bool LayoutDocEntryMemberDecl::m_visible

Definition at line 127 of file layout.h.

127 bool m_visible;

Referenced by LayoutDocEntryMemberDecl and visible.

---

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

• layout.cpp
• layout.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.