LayoutDocEntrySimple Struct Reference

Represents of a piece of a documentation page without configurable parts. More...

#include <src/layout.h>

Inheritance diagram for LayoutDocEntrySimple:

Collaboration diagram for LayoutDocEntrySimple:

Public Member Functions
	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
Kind	m_kind
std::string	m_id
bool	m_visible

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

Detailed Description

Represents of a piece of a documentation page without configurable parts.

Definition at line 88 of file layout.h.

Constructor & Destructor Documentation

LayoutDocEntrySimple()

LayoutDocEntrySimple::LayoutDocEntrySimple ( Kind k, const std::string & id, bool v )

inline

Definition at line 91 of file layout.h.

: m_kind(k), m_id(id), m_visible(v) {}

References id(), m_id, m_kind, and m_visible.

Referenced by LayoutDocEntrySection::LayoutDocEntrySection().

Member Function Documentation

id()

std::string LayoutDocEntrySimple::id ( ) const

inlineoverridevirtual

Implements LayoutDocEntry.

Definition at line 94 of file layout.h.

{ return m_id; }

References m_id.

Referenced by LayoutDocEntrySection::LayoutDocEntrySection(), and LayoutDocEntrySimple().

kind()

Kind LayoutDocEntrySimple::kind ( ) const

inlineoverridevirtual

Implements LayoutDocEntry.

Definition at line 92 of file layout.h.

{ return m_kind; }

References m_kind.

visible()

bool LayoutDocEntrySimple::visible ( ) const

inlineoverridevirtual

Implements LayoutDocEntry.

Definition at line 93 of file layout.h.

{ return m_visible; }

References m_visible.

Referenced by LayoutParser::endMemberDecl(), and LayoutParser::endMemberDef().

Member Data Documentation

m_id

std::string LayoutDocEntrySimple::m_id

private

Definition at line 97 of file layout.h.

Referenced by id(), and LayoutDocEntrySimple().

m_kind

Kind LayoutDocEntrySimple::m_kind

private

Definition at line 96 of file layout.h.

Referenced by kind(), and LayoutDocEntrySimple().

m_visible

bool LayoutDocEntrySimple::m_visible

private

Definition at line 98 of file layout.h.

Referenced by LayoutDocEntrySimple(), and visible().

---

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

• src/layout.h