PageGranularity Enum
- Namespace
- Kampute.DocToolkit
- Assembly
- Kampute.DocToolkit.dll
Definition
Specifies how documentation content is organized into addressable pages, affecting URLs and navigation structure.
[Flags]
public enum PageGranularity- Attributes
- Inheritance
Fields
| Name | Value | Description |
|---|---|---|
| None | 0 | No page granularity, resulting in all content being documented within the same page. |
| Namespace | 1 | Indicates that namespaces have their own documentation pages. |
| Type | 2 | Indicates that types have their own documentation pages. |
| Member | 4 | Indicates that type members have their own documentation pages. |
| NamespaceType | 3 | Indicates that namespaces and types have their own documentation pages, but type members are documented within their containing type pages. |
| NamespaceTypeMember | 7 | Indicates that namespaces, types, and type members all have their own documentation pages. |
Remarks
The page granularity is a key architectural decision that impacts the entire documentation structure. The chosen granularity affects navigation patterns, URL structure, search engine optimization, and overall user experience. Different granularity levels offer trade-offs between content density and navigational complexity.