The LayoutDocEntryMemberDef Struct Reference

Represents of a member definition list with configurable title. More...

Declaration

struct LayoutDocEntryMemberDef { ... }

Included Headers

#include <src/layout.h>

Base struct

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

Public Constructors Index

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

Public Member Functions Index

Kind	kind () const override
QCString	title (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
bool	m_visible

Description

Represents of a member definition list with configurable title.

Definition at line 131 of file layout.h.

Public Constructors

LayoutDocEntryMemberDef()

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

inline

Definition at line 133 of file layout.h.

133 LayoutDocEntryMemberDef(MemberListType tp,const std::string &id, const QCString &tl,bool v)

134 : type(tp), m_id(id), m_title(tl), m_visible(v) {}

References id, m_id, m_title, m_visible and type.

Public Member Functions

id()

std::string LayoutDocEntryMemberDef::id ()

inline virtual

Definition at line 140 of file layout.h.

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

Reference m_id.

Referenced by LayoutDocEntryMemberDef.

kind()

Kind LayoutDocEntryMemberDef::kind ()

inline virtual

Definition at line 136 of file layout.h.

136 Kind kind() const override { return MemberDef; }

title()

QCString LayoutDocEntryMemberDef::title (SrcLangExt lang)

Declaration at line 138 of file layout.h, definition at line 1798 of file layout.cpp.

1798QCString LayoutDocEntryMemberDef::title(SrcLangExt lang) const

1799{

1800 return extractLanguageSpecificTitle(m_title,lang);

1801}

References extractLanguageSpecificTitle and m_title.

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

visible()

bool LayoutDocEntryMemberDef::visible ()

inline virtual

Definition at line 139 of file layout.h.

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

Reference m_visible.

Public Member Attributes

type

MemberListType LayoutDocEntryMemberDef::type

Definition at line 137 of file layout.h.

137 MemberListType type;

Referenced by addMembersToIndex, NamespaceDefImpl::countVisibleMembers, LayoutDocEntryMemberDef, FileDefImpl::writeDocumentation, GroupDefImpl::writeDocumentation, ModuleDefImpl::writeDocumentation, NamespaceDefImpl::writeDocumentation, ClassDefImpl::writeDocumentationContents, writeGroupTreeNode, ClassDefImpl::writeInlineDocumentation and writeNamespaceMembers.

Private Member Attributes

m_id

std::string LayoutDocEntryMemberDef::m_id

Definition at line 142 of file layout.h.

142 std::string m_id;

Referenced by id and LayoutDocEntryMemberDef.

m_title

QCString LayoutDocEntryMemberDef::m_title

Definition at line 143 of file layout.h.

143 QCString m_title;

Referenced by LayoutDocEntryMemberDef and title.

m_visible

bool LayoutDocEntryMemberDef::m_visible

Definition at line 144 of file layout.h.

144 bool m_visible;

Referenced by LayoutDocEntryMemberDef 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.