DocumentPageRenderer.Render Method

Namespace

Assembly

Kampute.DocToolkit.dll

Definition

Renders the specified documentation page.

protected abstract void Render(TextWriter writer, PageCategory category, IDocumentModel model)

Parameters

writer TextWriter: The text writer to render the documentation to.
category PageCategory: The category of the documentation page to render.
model IDocumentModel: The model to render.

Remarks

This method renders different types of documentation pages based on the specified category. The following table shows the mapping between page categories and model types:

Page Category	Model Type
PageCategory.Topic	TopicModel
PageCategory.Namespace	NamespaceModel
PageCategory.Class	ClassModel
PageCategory.ClassWithMembers	ClassModel
PageCategory.Struct	StructModel
PageCategory.StructWithMembers	StructModel
PageCategory.Interface	InterfaceModel
PageCategory.InterfaceWithMembers	InterfaceModel
PageCategory.Enum	EnumModel
PageCategory.Delegate	DelegateModel
PageCategory.Constructor	ConstructorModel
PageCategory.ConstructorOverloads	OverloadCollection<T> where `T` is ConstructorModel
PageCategory.Field	FieldModel
PageCategory.Event	EventModel
PageCategory.Property	PropertyModel
PageCategory.PropertyOverloads	OverloadCollection<T> where `T` is PropertyModel
PageCategory.Method	MethodModel
PageCategory.MethodOverloads	OverloadCollection<T> where `T` is MethodModel
PageCategory.Operator	OperatorModel
PageCategory.OperatorOverloads	OverloadCollection<T> where `T` is OperatorModel