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 {   MemberGroups , MemberDeclStart , MemberDeclEnd , MemberDecl ,   MemberDefStart , MemberDefEnd , MemberDef , BriefDesc ,   DetailedDesc , AuthorSection , ClassIncludes , ClassInlineClasses ,   ClassInheritanceGraph , ClassNestedClasses , ClassCollaborationGraph , ClassAllMembersLink ,   ClassUsedFiles , ConceptDefinition , NamespaceNestedNamespaces , NamespaceNestedConstantGroups ,   NamespaceClasses , NamespaceConcepts , NamespaceInterfaces , NamespaceStructs ,   NamespaceExceptions , NamespaceInlineClasses , FileClasses , FileConcepts ,   FileInterfaces , FileStructs , FileExceptions , FileConstantGroups ,   FileNamespaces , FileIncludes , FileIncludeGraph , FileIncludedByGraph ,   FileSourceLink , FileInlineClasses , ModuleExports , ModuleClasses ,   ModuleConcepts , ModuleUsedFiles , GroupClasses , GroupConcepts ,   GroupModules , GroupInlineClasses , GroupNamespaces , GroupDirs ,   GroupNestedGroups , GroupFiles , GroupGraph , GroupPageDocs ,   DirSubDirs , DirFiles , DirGraph }

Public Member Functions
virtual Kind	kind () const =0

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
MemberGroups
MemberDeclStart
MemberDeclEnd
MemberDecl
MemberDefStart
MemberDefEnd
MemberDef
BriefDesc
DetailedDesc
AuthorSection
ClassIncludes
ClassInlineClasses
ClassInheritanceGraph
ClassNestedClasses
ClassCollaborationGraph
ClassAllMembersLink
ClassUsedFiles
ConceptDefinition
NamespaceNestedNamespaces
NamespaceNestedConstantGroups
NamespaceClasses
NamespaceConcepts
NamespaceInterfaces
NamespaceStructs
NamespaceExceptions
NamespaceInlineClasses
FileClasses
FileConcepts
FileInterfaces
FileStructs
FileExceptions
FileConstantGroups
FileNamespaces
FileIncludes
FileIncludeGraph
FileIncludedByGraph
FileSourceLink
FileInlineClasses
ModuleExports
ModuleClasses
ModuleConcepts
ModuleUsedFiles
GroupClasses
GroupConcepts
GroupModules
GroupInlineClasses
GroupNamespaces
GroupDirs
GroupNestedGroups
GroupFiles
GroupGraph
GroupPageDocs
DirSubDirs
DirFiles
DirGraph

Definition at line 36 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,
 
              // Concept specific items
              ConceptDefinition,
 
              // Namespace specific items
              NamespaceNestedNamespaces, NamespaceNestedConstantGroups,
              NamespaceClasses, NamespaceConcepts, NamespaceInterfaces, NamespaceStructs, NamespaceExceptions,
              NamespaceInlineClasses,
 
              // File specific items
              FileClasses, FileConcepts, FileInterfaces, FileStructs, FileExceptions, FileConstantGroups, FileNamespaces,
              FileIncludes, FileIncludeGraph,
              FileIncludedByGraph, FileSourceLink,
              FileInlineClasses,
 
              // C++20 Modules
              ModuleExports, ModuleClasses, ModuleConcepts, ModuleUsedFiles,
 
              // Group specific items
              GroupClasses, GroupConcepts, GroupModules, GroupInlineClasses, GroupNamespaces,
              GroupDirs, GroupNestedGroups, GroupFiles,
              GroupGraph, GroupPageDocs,
 
              // Directory specific items
              DirSubDirs, DirFiles, DirGraph
 
            };

Member Function Documentation

kind()

virtual Kind LayoutDocEntry::kind ( ) const

pure virtual

Implemented in LayoutDocEntryMemberDecl, LayoutDocEntryMemberDef, and LayoutDocEntrySimple.

---

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

• src/layout.h