The LayoutDocEntry Struct Reference

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

Declaration

struct LayoutDocEntry { ... }

Included Headers

#include <src/layout.h>

Derived Structs

struct	LayoutDocEntryMemberDecl
	Represents of a member declaration list with configurable title and subtitle. More...
struct	LayoutDocEntryMemberDef
	Represents of a member definition list with configurable title. More...
struct	LayoutDocEntrySimple
	Represents of a piece of a documentation page without configurable parts. More...

Enumerations Index

enum	Kind { ... }

Public Member Functions Index

Kind	kind () const =0
std::string	entryToString () const
std::string	id () const =0
bool	visible () const =0

Description

Base class representing a piece of a documentation page.

Definition at line 31 of file layout.h.

Enumerations

Kind

enum LayoutDocEntry::Kind

Enumeration values

ENTRY_SPECIFICATIONS

Definition at line 67 of file layout.h.

67 enum Kind {

68#define ESPEC(x) x,

69 ENTRY_SPECIFICATIONS

70#undef ESPEC

71 };

Public Member Functions

entryToString()

std::string LayoutDocEntry::entryToString ()

inline

Definition at line 73 of file layout.h.

73 std::string entryToString() const

74 {

75 switch (kind())

76 {

77#define ESPEC(x) case x: return #x; break;

78 ENTRY_SPECIFICATIONS

79#undef ESPEC

80 default: return "unknown"; // to satisfy compiler

81 }

82 }

References ENTRY_SPECIFICATIONS and kind.

id()

virtual std::string LayoutDocEntry::id ()

Definition at line 83 of file layout.h.

kind()

virtual Kind LayoutDocEntry::kind ()

Definition at line 72 of file layout.h.

Referenced by entryToString.

visible()

virtual bool LayoutDocEntry::visible ()

Definition at line 84 of file layout.h.

---

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

• layout.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.