ConvertibleTopic.CreateContentReader Method

Namespace

Kampute.DocToolkit.Topics.Abstracts

Assembly

Kampute.DocToolkit.dll

Definition

Creates a TextReader that provides the rendered content of the documentation based on the specified context.

protected abstract TextReader CreateContentReader(IDocumentationContext context)

Parameters

context IDocumentationContext: The context containing the information and settings required to render the documentation.

Returns

TextReader: A TextReader containing the rendered documentation content.

Remarks

The ConvertibleTopic.CreateContentReader(IDocumentationContext) method is responsible for generating the content of a topic in the format specified by the ConvertibleTopic.ContentFormat property.

This method is typically called during the documentation generation process to retrieve the content for each topic. The returned TextReader should provide the fully rendered content with all cross-references, formatting, and other transformations applied according to the context's settings.

Implementations should ensure that the returned TextReader is properly initialized and ready for reading. The caller is responsible for disposing the TextReader when finished with it.