Documentation Language: Swift

Initializer

init(outputDirectory:generatedPages:modulesDocumented:symbolsDocumented:articlesGenerated:tutorialsGenerated:warnings:searchIndexPath:)

Creates a new generation result.

init(outputDirectory: URL, generatedPages: Int, modulesDocumented: Int, symbolsDocumented: Int, articlesGenerated: Int, tutorialsGenerated: Int, warnings: [Warning], searchIndexPath: URL?)

Parameters

outputDirectory

The directory where documentation was written.

generatedPages

The total number of HTML pages generated.

modulesDocumented

The number of modules documented.

symbolsDocumented

The number of symbols documented.

articlesGenerated

The number of articles generated.

tutorialsGenerated

The number of tutorials generated.

warnings

Warnings encountered during generation.

searchIndexPath

The path to the search index, if generated.