LayoutDocEntryMemberDecl Struct Reference

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

#include <src/layout.h>

Inheritance diagram for LayoutDocEntryMemberDecl:

Collaboration diagram for LayoutDocEntryMemberDecl:

Public Member Functions
	LayoutDocEntryMemberDecl (MemberListType tp, const std::string &id, const QCString &tl, const QCString &ss, bool v)
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 Functions inherited from LayoutDocEntry
std::string	entryToString () const

Public Attributes
MemberListType	type

Private Attributes
std::string	m_id
QCString	m_title
QCString	m_subscript
bool	m_visible

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

Detailed Description

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

Definition at line 111 of file layout.h.

Constructor & Destructor Documentation

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.

    : 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.

Member Function Documentation

id()

std::string LayoutDocEntryMemberDecl::id ( ) const

inlineoverridevirtual

Implements LayoutDocEntry.

Definition at line 122 of file layout.h.

{ return m_id; }

References m_id.

Referenced by LayoutDocEntryMemberDecl().

kind()

Kind LayoutDocEntryMemberDecl::kind ( ) const

inlineoverridevirtual

Implements LayoutDocEntry.

Definition at line 117 of file layout.h.

{ return MemberDecl; }

subtitle()

QCString LayoutDocEntryMemberDecl::subtitle

(

SrcLangExt

lang

)

const

Definition at line 1791 of file layout.cpp.

{
  return extractLanguageSpecificTitle(m_subscript,lang);
}

References extractLanguageSpecificTitle(), and m_subscript.

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

title()

QCString LayoutDocEntryMemberDecl::title

(

SrcLangExt

lang

)

const

Definition at line 1786 of file layout.cpp.

{
  return extractLanguageSpecificTitle(m_title,lang);
}

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 ( ) const

inlineoverridevirtual

Implements LayoutDocEntry.

Definition at line 121 of file layout.h.

{ return m_visible; }

References m_visible.

Referenced by ModuleDefImpl::writeTagFile().

Member Data Documentation

m_id

std::string LayoutDocEntryMemberDecl::m_id

private

Definition at line 124 of file layout.h.

Referenced by id(), and LayoutDocEntryMemberDecl().

m_subscript

QCString LayoutDocEntryMemberDecl::m_subscript

private

Definition at line 126 of file layout.h.

Referenced by LayoutDocEntryMemberDecl(), and subtitle().

m_title

QCString LayoutDocEntryMemberDecl::m_title

private

Definition at line 125 of file layout.h.

Referenced by LayoutDocEntryMemberDecl(), and title().

m_visible

bool LayoutDocEntryMemberDecl::m_visible

private

Definition at line 127 of file layout.h.

Referenced by LayoutDocEntryMemberDecl(), and visible().

type

MemberListType LayoutDocEntryMemberDecl::type

Definition at line 118 of file layout.h.

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().

---

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

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