Structure
GenerationResult
The result of a documentation generation operation.
struct GenerationResultOverview
This type contains information about the generated documentation, including the number of pages created, any warnings encountered, and paths to key files.
Topics
Initializers
?
Instance Properties
V
articlesGenerated
The number of articles generated.
V
generatedPages
The total number of HTML pages generated.
V
indexPath
The path to the main index.html file.
V
modulesDocumented
The number of modules documented.
V
outputDirectory
The directory where documentation was written.
V
searchIndexPath
The path to the generated search index, if search was enabled.
V
symbolsDocumented
The number of symbols documented.
V
tutorialsGenerated
The number of tutorials generated.
V
warnings
Warnings encountered during generation.
Default Implementations
Relationships
Conforms To
See Also
Library API
A
Configuration Reference
Configure DocCStatic for your documentation needs.
S
StaticDocumentationGenerator
The main orchestrator for generating static HTML documentation.
E
GenerationError
Errors that can occur during documentation generation.