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

#include <src/layout.h>

Inheritance diagram for LayoutDocEntry:

Public Types
enum	Kind { ENTRY_SPECIFICATIONS }

Public Member Functions
virtual Kind	kind () const =0

std::string	entryToString ()

Detailed Description

Base class representing a piece of a documentation page.

Definition at line 32 of file layout.h.

Member Enumeration Documentation

◆ Kind

enum LayoutDocEntry::Kind

Enumerator
ENTRY_SPECIFICATIONS

Definition at line 68 of file layout.h.

            {
#define ESPEC(x) x,
      ENTRY_SPECIFICATIONS
#undef ESPEC
            };

Member Function Documentation

◆ entryToString()

std::string LayoutDocEntry::entryToString ( )

inline

Definition at line 74 of file layout.h.

  {
    switch (kind())
    {
#define ESPEC(x) case x: return #x; break;
      ENTRY_SPECIFICATIONS
#undef ESPEC
      default: return "unknown"; // to satisfy compiler
    }
  }

References ENTRY_SPECIFICATIONS, and kind().

◆ kind()

virtual Kind LayoutDocEntry::kind ( ) const

pure virtual

Implemented in LayoutDocEntryMemberDecl, LayoutDocEntryMemberDef, and LayoutDocEntrySimple.

Referenced by entryToString().

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

src/layout.h