LayoutDocEntry Struct Reference

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

#include <layout.h>

Inheritance diagram for LayoutDocEntry:

Public Types
enum	Kind {   MemberGroups, MemberDeclStart, MemberDeclEnd, MemberDecl,   MemberDefStart, MemberDefEnd, MemberDef, BriefDesc,   DetailedDesc, AuthorSection, ClassIncludes, ClassInlineClasses,   ClassInheritanceGraph, ClassNestedClasses, ClassCollaborationGraph, ClassAllMembersLink,   ClassUsedFiles, NamespaceNestedNamespaces, NamespaceNestedConstantGroups, NamespaceClasses,   NamespaceInlineClasses, FileClasses, FileNamespaces, FileConstantGroups,   FileIncludes, FileIncludeGraph, FileIncludedByGraph, FileSourceLink,   FileInlineClasses, GroupClasses, GroupInlineClasses, GroupNamespaces,   GroupDirs, GroupNestedGroups, GroupFiles, GroupGraph,   GroupPageDocs, DirSubDirs, DirFiles, DirGraph }

Public Member Functions
virtual	~LayoutDocEntry ()
virtual Kind	kind () const =0

Detailed Description

Base class representing a piece of a documentation page.

Definition at line 30 of file layout.h.

Member Enumeration Documentation

enum LayoutDocEntry::Kind

Enumerator
MemberGroups
MemberDeclStart
MemberDeclEnd
MemberDecl
MemberDefStart
MemberDefEnd
MemberDef
BriefDesc
DetailedDesc
AuthorSection
ClassIncludes
ClassInlineClasses
ClassInheritanceGraph
ClassNestedClasses
ClassCollaborationGraph
ClassAllMembersLink
ClassUsedFiles
NamespaceNestedNamespaces
NamespaceNestedConstantGroups
NamespaceClasses
NamespaceInlineClasses
FileClasses
FileNamespaces
FileConstantGroups
FileIncludes
FileIncludeGraph
FileIncludedByGraph
FileSourceLink
FileInlineClasses
GroupClasses
GroupInlineClasses
GroupNamespaces
GroupDirs
GroupNestedGroups
GroupFiles
GroupGraph
GroupPageDocs
DirSubDirs
DirFiles
DirGraph

Definition at line 33 of file layout.h.

            { 
              // Generic items for all pages
              MemberGroups,
              MemberDeclStart, MemberDeclEnd, MemberDecl,
              MemberDefStart, MemberDefEnd, MemberDef,
              BriefDesc, DetailedDesc,
              AuthorSection,
              
              // Class specific items
              ClassIncludes, ClassInlineClasses,
              ClassInheritanceGraph, ClassNestedClasses,
              ClassCollaborationGraph, ClassAllMembersLink,
              ClassUsedFiles,

              // Namespace specific items
              NamespaceNestedNamespaces, NamespaceNestedConstantGroups,
              NamespaceClasses, NamespaceInlineClasses,

              // File specific items
              FileClasses, FileNamespaces, FileConstantGroups,
              FileIncludes, FileIncludeGraph, 
              FileIncludedByGraph, FileSourceLink,
              FileInlineClasses,

              // Group specific items
              GroupClasses, GroupInlineClasses, GroupNamespaces,
              GroupDirs, GroupNestedGroups, GroupFiles,
              GroupGraph, GroupPageDocs,

              // Directory specific items
              DirSubDirs, DirFiles, DirGraph

            };

Constructor & Destructor Documentation

virtual LayoutDocEntry::~LayoutDocEntry ( )

inlinevirtual

Definition at line 32 of file layout.h.

{}

Member Function Documentation

virtual Kind LayoutDocEntry::kind ( ) const

pure virtual

Implemented in LayoutDocEntryMemberDef, LayoutDocEntryMemberDecl, and LayoutDocEntrySimple.

---

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

• doxygen-1.8.11/src/layout.h