The LayoutDocEntrySimple Struct Reference

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

Declaration

struct LayoutDocEntrySimple { ... }

Included Headers

#include <src/layout.h>

Base struct

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

Derived Structs

struct	LayoutDocEntrySection

Public Constructors Index

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

Public Member Functions Index

Kind	kind () const override
bool	visible () const override
std::string	id () const override

Private Member Attributes Index

Kind	m_kind
std::string	m_id
bool	m_visible

Description

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

Definition at line 88 of file layout.h.

Public Constructors

LayoutDocEntrySimple()

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

inline

Definition at line 91 of file layout.h.

91 LayoutDocEntrySimple(Kind k,const std::string &id, bool v) : m_kind(k), m_id(id), m_visible(v) {}

References id, m_id, m_kind and m_visible.

Referenced by LayoutDocEntrySection::LayoutDocEntrySection.

Public Member Functions

id()

std::string LayoutDocEntrySimple::id ()

inline virtual

Definition at line 94 of file layout.h.

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

Reference m_id.

Referenced by LayoutDocEntrySection::LayoutDocEntrySection and LayoutDocEntrySimple.

kind()

Kind LayoutDocEntrySimple::kind ()

inline virtual

Definition at line 92 of file layout.h.

92 Kind kind() const override { return m_kind; }

Reference m_kind.

visible()

bool LayoutDocEntrySimple::visible ()

inline virtual

Definition at line 93 of file layout.h.

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

Reference m_visible.

Referenced by LayoutParser::endMemberDecl and LayoutParser::endMemberDef.

Private Member Attributes

m_id

std::string LayoutDocEntrySimple::m_id

Definition at line 97 of file layout.h.

97 std::string m_id;

Referenced by id and LayoutDocEntrySimple.

m_kind

Kind LayoutDocEntrySimple::m_kind

Definition at line 96 of file layout.h.

96 Kind m_kind;

Referenced by kind and LayoutDocEntrySimple.

m_visible

bool LayoutDocEntrySimple::m_visible

Definition at line 98 of file layout.h.

98 bool m_visible;

Referenced by LayoutDocEntrySimple and visible.

---

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

• layout.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.