import WorkspaceConfiguration .product(name: "WorkspaceConfiguration", package: "Workspace")
Structure

APIDocumentationConfiguration

Options related to API documentation.

Declaration

struct APIDocumentationConfiguration

Properties

copyrightNotice

The copyright notice.

enforceCoverage

Whether or not to enforce documentation coverage.

fileNameReplacements

Replacements to apply to the file names of the generated documentation.

generate

Whether or not to generate API documentation.

ignoredDependencies

Dependency module names known to be irrelevant to documentation.

serveFromGitHubPagesBranch

Whether or not to automatically serve the documentation using GitHub Pages.

yearFirstPublished

The year the documentation was first published.

Methods

applyWindowsCompatibilityFileNameReplacements()

Adds file name replacements necessary for Windows file systems.

Codable

macOS CentOS Ubuntu Amazon Linux