InitializerInitializerinit(output
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
outputDirectoryThe directory where documentation was written.
generatedPagesThe total number of HTML pages generated.
modulesDocumentedThe number of modules documented.
symbolsDocumentedThe number of symbols documented.
articlesGeneratedThe number of articles generated.
tutorialsGeneratedThe number of tutorials generated.
warningsWarnings encountered during generation.
searchIndexPathThe path to the search index, if generated.