LayoutDocEntry Struct Reference

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 () const
virtual std::string	id () const =0
virtual bool	visible () const =0

Detailed Description

Base class representing a piece of a documentation page.

Definition at line 31 of file layout.h.

Member Enumeration Documentation

Kind

enum LayoutDocEntry::Kind

Enumerator
ENTRY_SPECIFICATIONS

Definition at line 67 of file layout.h.

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

Member Function Documentation

entryToString()

std::string LayoutDocEntry::entryToString ( ) const

inline

Definition at line 73 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().

id()

virtual std::string LayoutDocEntry::id ( ) const

pure virtual

Implemented in LayoutDocEntryMemberDecl, LayoutDocEntryMemberDef, and LayoutDocEntrySimple.

kind()

virtual Kind LayoutDocEntry::kind ( ) const

pure virtual

Implemented in LayoutDocEntryMemberDecl, LayoutDocEntryMemberDef, and LayoutDocEntrySimple.

Referenced by entryToString().

visible()

virtual bool LayoutDocEntry::visible ( ) const

pure virtual

Implemented in LayoutDocEntryMemberDecl, LayoutDocEntryMemberDef, and LayoutDocEntrySimple.

---

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

• src/layout.h