FileSystemDocumentationComposer Class
- Namespace
- Kampute.DocToolkit
- Assembly
- Kampute.DocToolkit.dll
Definition
Represents a generator that creates documentation files for code elements in a given context.
public class FileSystemDocumentationComposer : DocumentationComposer- Inheritance
- object
- DocumentationComposer
- FileSystemDocumentationComposer
Remarks
Constructors
| FileSystemDocumentationComposer(IDocumentRenderer) | Initializes a new instance of the FileSystemDocumentationComposer class. |
Properties
| Renderer | Gets the documentation renderer. |
Methods
| GenerateDocumentation(IDocumentationContext, string, OutputOptions) | Generates documentation pages for the specified context and writes the output to the specified folder. |

This class serves as the main entry point for the documentation generation process, taking a documentation context (containing assemblies and XML documentations) and producing organized documentation files. It handles both the logical organization of documentation content and the physical file output.
Typical usage involves: