LayoutDocEntry结构体 参考

Base class representing a piece of a documentation page 更多...

#include <layout.h>

类 LayoutDocEntry 继承关系图:

Public 类型
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, GroupClasses, GroupConcepts,   GroupInlineClasses, GroupNamespaces, GroupDirs, GroupNestedGroups,   GroupFiles, GroupGraph, GroupPageDocs, DirSubDirs,   DirFiles, DirGraph }

Public 成员函数
virtual	~LayoutDocEntry ()
virtual Kind	kind () const =0

详细描述

Base class representing a piece of a documentation page

在文件 layout.h 第 31 行定义.

成员枚举类型说明

Kind

enum LayoutDocEntry::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
GroupClasses
GroupConcepts
GroupInlineClasses
GroupNamespaces
GroupDirs
GroupNestedGroups
GroupFiles
GroupGraph
GroupPageDocs
DirSubDirs
DirFiles
DirGraph

在文件 layout.h 第 34 行定义.

            {
              // 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,
 
              // Group specific items
              GroupClasses, GroupConcepts, GroupInlineClasses, GroupNamespaces,
              GroupDirs, GroupNestedGroups, GroupFiles,
              GroupGraph, GroupPageDocs,
 
              // Directory specific items
              DirSubDirs, DirFiles, DirGraph
 
            };

构造及析构函数说明

~LayoutDocEntry()

virtual LayoutDocEntry::~LayoutDocEntry ( )

inlinevirtual

在文件 layout.h 第 33 行定义.

{}

成员函数说明

kind()

virtual Kind LayoutDocEntry::kind ( ) const

pure virtual

在 LayoutDocEntryMemberDef, LayoutDocEntryMemberDecl , 以及 LayoutDocEntrySimple 内被实现.

---

该结构体的文档由以下文件生成:

• src/layout.h