ConvertibleTopic Class

Namespace
Kampute.DocToolkit.Topics.Abstracts
Assembly
  • Kampute.DocToolkit.dll

Definition

Provides the base functionality for a topic source that requires content conversion.
public abstract class ConvertibleTopic : TopicSource
Inheritance
Inherited by

Remarks

This class handles the transformation of content from its source format to the output format required by the documentation system.

Thread Safety

Public static members of the type are guaranteed to be thread-safe. However, public instance members are not thread-safe.

Constructors

ConvertibleTopic(string)Initializes a new instance of the ConvertibleTopic class.

Properties

ContentFormatGets the format of the source content.

Methods

CreateContentReader(IDocumentationContext)Creates a TextReader that provides the rendered content of the documentation based on the specified context.
Render(TextWriter, IDocumentationContext)Renders the documentation content to the specified TextWriter using the provided documentation context.