Skip to content

Latest commit

 

History

History
130 lines (94 loc) · 3.15 KB

DocumentOptions.md

File metadata and controls

130 lines (94 loc) · 3.15 KB

STRUCT

DocumentOptions

public struct DocumentOptions

Configuration for DocumentationGenerator

  • Parameters:
    • allModules: Generate documentation for all modules in a Swift package.
    • spmModule: Generate documentation for Swift Package Manager module.
    • moduleName: Generate documentation for a Swift module.
    • linkBeginningText: The text to begin links with. Defaults to an empty string.
    • linkEndingText: The text to end links with. Defaults to '.md'.
    • inputFolder: Path to the input directory.
    • outputFolder: Output directory.
    • minimumAccessLevel: The minimum access level to generate documentation. Defaults to public.
    • includeModuleNameInPath: Include the module name as part of the output folder path. Defaults to false.
    • clean: Delete output folder before generating documentation. Defaults to false.
    • collapsibleBlocks: Put methods, properties and enum cases inside collapsible blocks. Defaults to false.
    • tableOfContents: Generate a table of contents with properties and methods for each type. Defaults to false.
    • xcodeArguments: Array of String arguments to pass to xcodebuild. Defaults to an empty array.
    • reproducibleDocs: generate documentation that is reproducible: only depends on the sources. For example, this will avoid adding timestamps on the generated files. Defaults to false.
    • skipEmpty: Do not generate documentation for files with no comments.

Properties

allModules

public let allModules: Bool

spmModule

public let spmModule: String?

moduleName

public let moduleName: String?

linkBeginningText

public let linkBeginningText: String

linkEndingText

public let linkEndingText: String

inputFolder

public let inputFolder: String

outputFolder

public let outputFolder: String

minimumAccessLevel

public let minimumAccessLevel: AccessLevel

includeModuleNameInPath

public var includeModuleNameInPath: Bool

clean

public let clean: Bool

collapsibleBlocks

public let collapsibleBlocks: Bool

tableOfContents

public let tableOfContents: Bool

xcodeArguments

public let xcodeArguments: [String]

reproducibleDocs

public let reproducibleDocs: Bool

skipEmpty

public let skipEmpty: Bool

Methods

init(allModules:spmModule:moduleName:linkBeginningText:linkEndingText:inputFolder:outputFolder:minimumAccessLevel:includeModuleNameInPath:clean:collapsibleBlocks:tableOfContents:xcodeArguments:reproducibleDocs:skipEmpty:)

public init(allModules: Bool, spmModule: String?, moduleName: String?,
            linkBeginningText: String = "", linkEndingText: String = ".md",
            inputFolder: String, outputFolder: String,
            minimumAccessLevel: AccessLevel = .public, includeModuleNameInPath: Bool = false,
            clean: Bool = false, collapsibleBlocks: Bool = false, tableOfContents: Bool = false,
            xcodeArguments: [String] = [], reproducibleDocs: Bool = false, skipEmpty: Bool = false)