PageCategory Enum

Namespace

Assembly

Kampute.DocToolkit.dll

Definition

Represents the documentation page categories.

public enum PageCategory

Inheritance

object
ValueType
Enum
PageCategory

Fields

Name	Value	Description
Topic	0	The documentation page for a topic.
Namespace	1	The documentation page for a `namespace`.
NamespaceWithTypes	2	The documentation page for a `namespace`, including documentation of its contained types on the same page.
Class	3	The documentation page for a `class`.
ClassWithMembers	4	The documentation page for a `class`, including documentation of its members on the same page.
Struct	5	The documentation page for a `struct`.
StructWithMembers	6	The documentation page for a `struct`, including documentation of its members on the same page.
Interface	7	The documentation page for an `interface`.
InterfaceWithMembers	8	The documentation page for an `interface`, including documentation of its members on the same page.
Enum	9	The documentation page for an `enum`.
Delegate	10	The documentation page for a `delegate`.
Constructor	11	The documentation page for a constructor.
ConstructorOverloads	12	The documentation page for a collection of overloaded constructors.
Field	13	The documentation page for a field.
Event	14	The documentation page for an event.
Property	15	The documentation page for a property.
PropertyOverloads	16	The documentation page for a collection of overloaded properties.
Method	17	The documentation page for a method.
MethodOverloads	18	The documentation page for a collection of overloaded methods.
Operator	19	The documentation page for an operator.
OperatorOverloads	20	The documentation page for a collection of overloaded operators.

Remarks

The PageCategory enum provides a standardized way to identify different types of documentation pages that can be generated. This classification is essential for documentation renderers to apply appropriate templates and formatting based on the content type being presented. It enables the documentation generation system to handle different code elements consistently while allowing for specialized presentation of each category.

Categories are organized into three main groups:

Topic and namespace pages (general organization)
Type pages (classes, structs, interfaces, enums, and delegates)
Member pages (constructors, fields, properties, methods, events, and operators)

Some categories indicate whether members are documented on the same page as their containing type (e.g., ClassWithMembers) or on separate pages.