FileSystemDocumentWriterFactory.CreateTextWriter Method

Namespace

Assembly

Kampute.DocToolkit.dll

Definition

Creates a TextWriter for writing documentation content to the specified relative path.

public virtual TextWriter CreateTextWriter(string relativePath)

Parameters

relativePath string: The relative path where the documentation content will be written.

Returns

TextWriter: A TextWriter for writing documentation content.

Exceptions

ArgumentNullException: Thrown when relativePath is null or empty.

Remarks

This method combines the FileSystemDocumentWriterFactory.OutputFolder property with the specified relativePath to determine the full file path. If the directory for the resulting path does not exist, it will be created automatically. The returned TextWriter writes directly to the specified file and does not apply any content transformations, such as minification.