StructureStructureGeneration
GenerationResult
The result of a documentation generation operation.
struct GenerationResultMentioned in
Overview
This type contains information about the generated documentation, including the number of pages created, any warnings encountered, and paths to key files.
Topics
let articlesGenerated : Int articlesThe number of articles generated.
let generatedPages : Int generatedThe total number of HTML pages generated.
var indexPath : URL indexThe path to the main index.html file.
let modulesDocumented : Int modulesThe number of modules documented.
let outputDirectory : URL outputThe directory where documentation was written.
let searchIndexPath : URL? searchThe path to the generated search index, if search was enabled.
let symbolsDocumented : Int symbolsThe number of symbols documented.
let tutorialsGenerated : Int tutorialsThe number of tutorials generated.
let warnings: [Warning] warningsWarnings encountered during generation.
Relationships
Swift.Equatable Swift.Hashable Swift.Sendable Swift.Sendable Metatype
See Also
Configuration Reference
Configure DocCStatic for your documentation needs.
struct StaticDocumentationGenerator StaticThe main orchestrator for generating static HTML documentation.
enum GenerationError GenerationErrors that can occur during documentation generation.