LayoutDocEntryMemberDef Struct Reference

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

#include <src/layout.h>

Inheritance diagram for LayoutDocEntryMemberDef:

Collaboration diagram for LayoutDocEntryMemberDef:

Public Member Functions
	LayoutDocEntryMemberDef (MemberListType tp, const std::string &id, const QCString &tl, bool v)
Kind	kind () const override
QCString	title (SrcLangExt lang) const
bool	visible () const override
std::string	id () const override
Public Member Functions inherited from LayoutDocEntry
std::string	entryToString () const

Public Attributes
MemberListType	type

Private Attributes
std::string	m_id
QCString	m_title
bool	m_visible

Additional Inherited Members
Public Types inherited from LayoutDocEntry
enum	Kind { ENTRY_SPECIFICATIONS }

Detailed Description

Represents of a member definition list with configurable title.

Definition at line 131 of file layout.h.

Constructor & Destructor Documentation

LayoutDocEntryMemberDef()

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

inline

Definition at line 133 of file layout.h.

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

References id(), m_id, m_title, m_visible, and type.

Member Function Documentation

id()

std::string LayoutDocEntryMemberDef::id ( ) const

inlineoverridevirtual

Implements LayoutDocEntry.

Definition at line 140 of file layout.h.

{ return m_id; }

References m_id.

Referenced by LayoutDocEntryMemberDef().

kind()

Kind LayoutDocEntryMemberDef::kind ( ) const

inlineoverridevirtual

Implements LayoutDocEntry.

Definition at line 136 of file layout.h.

{ return MemberDef; }

title()

QCString LayoutDocEntryMemberDef::title

(

SrcLangExt

lang

)

const

Definition at line 1798 of file layout.cpp.

{
  return extractLanguageSpecificTitle(m_title,lang);
}

References extractLanguageSpecificTitle(), and m_title.

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

visible()

bool LayoutDocEntryMemberDef::visible ( ) const

inlineoverridevirtual

Implements LayoutDocEntry.

Definition at line 139 of file layout.h.

{ return m_visible; }

References m_visible.

Member Data Documentation

m_id

std::string LayoutDocEntryMemberDef::m_id

private

Definition at line 142 of file layout.h.

Referenced by id(), and LayoutDocEntryMemberDef().

m_title

QCString LayoutDocEntryMemberDef::m_title

private

Definition at line 143 of file layout.h.

Referenced by LayoutDocEntryMemberDef(), and title().

m_visible

bool LayoutDocEntryMemberDef::m_visible

private

Definition at line 144 of file layout.h.

Referenced by LayoutDocEntryMemberDef(), and visible().

type

MemberListType LayoutDocEntryMemberDef::type

Definition at line 137 of file layout.h.

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

---

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

• src/layout.h
• src/layout.cpp