Documentation Language: Swift

Documentation

docc-static

Essentials

Getting Started with docc-static
Using docc-static Locally

Deployment

Deploying Documentation to Servers
CI/CD Integration

Static Documentation Plugin

Essentials

Getting Started with the Plugin
Plugin Options

Integration

Xcode Integration

DocCStatic Library

Essentials

Getting Started with DocCStatic

Guides

Configuration Reference
Cross-Package Linking
Custom Themes

Library API

Configuration Reference
S StaticDocumentationGenerator
- Initializers
  - M init(configuration: Configuration)
- Instance Properties
  - P let configuration: Configuration
- Instance Methods
  - M func generate() async throws -> GenerationResult
  - M func renderFromArchive(URL) async throws -> GenerationResult
S GenerationResult
- Initializers
  - M init(outputDirectory: URL, generatedPages: Int, modulesDocumented: Int, symbolsDocumented: Int, articlesGenerated: Int, tutorialsGenerated: Int, warnings: [Warning], searchIndexPath: URL?)
- Instance Properties
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
E GenerationError
- Enumeration Cases
- Instance Properties
  - P var errorDescription: String?
- Default Implementations
  - Error Implementations
    - Instance Properties
      - P var localizedDescription: String
  - LocalizedError Implementations
    - Instance Properties

Rendering

S HTMLPageBuilder
S RenderContentHTMLRenderer
- Structures
  - S RenderContentHTMLRenderer.InlineResult
    - Instance Properties
      - P let html: String
      - P let plainText: String
- Initializers
  - M init()
- Instance Methods
  - M func renderBlockContent(RenderBlockContent, references: [String : any RenderReference], depth: Int) -> String
  - M func renderInlineContent([RenderInlineContent], references: [String : any RenderReference], depth: Int) -> InlineResult
S IndexPageBuilder
- Structures
  - S IndexPageBuilder.IndexContent
    - Instance Properties
      - P let bodyHTML: String
      - P let title: String?
  - S IndexPageBuilder.ModuleEntry
    - Initializers
      - M init(name: String, abstract: String, path: String, symbolCount: Int)
    - Instance Properties
      - P let abstract: String
      - P let name: String
      - P let path: String
      - P let symbolCount: Int
  - S IndexPageBuilder.TutorialEntry
    - Initializers
      - M init(title: String, path: String, tutorialCount: Int)
    - Instance Properties
      - P let path: String
      - P let title: String
      - P let tutorialCount: Int
- Initializers
  - M init(configuration: Configuration)
- Instance Properties
  - P let configuration: Configuration
- Instance Methods
  - M func buildIndexPage(modules: [ModuleEntry], tutorials: [TutorialEntry], indexContent: IndexContent?) -> String
  - M func loadIndexContent(from: URL) -> IndexContent?
- Type Properties
  - P static let indexMarkdownFilename: String
C StaticHTMLConsumer
- Initializers
  - M init(outputDirectory: URL, configuration: Configuration)
- Instance Properties
- Instance Methods
  - M func result() -> GenerationResult
- Default Implementations
  - ConvertOutputConsumer Implementations
    - Instance Methods

Search

S SearchIndexBuilder
- Structures
  - S SearchIndexBuilder.SearchDocument
    - Initializers
      - M init(from: any Decoder) throws
      - M init(id: String, title: String, type: String, path: String, summary: String, keywords: [String], module: String?, content: String)
    - Instance Properties
      - P let content: String
      - P let id: String
      - P let keywords: [String]
      - P let module: String?
      - P let path: String
      - P let summary: String
      - P let title: String
      - P let type: String
    - Default Implementations
      - Equatable Implementations
        
        Operators
        
        static func != (Self, Self) -> Bool
  - S SearchIndexBuilder.SearchIndex
    - Initializers
      - M init(from: any Decoder) throws
      - M init(version: String, documents: [SearchDocument])
    - Instance Properties
    - Default Implementations
      - Equatable Implementations
        
        Operators
        
        static func != (Self, Self) -> Bool
- Initializers
  - M init(configuration: Configuration)
- Instance Properties
  - P let configuration: Configuration
  - P var index: SearchIndex
- Instance Methods
  - M func addToIndex(RenderNode)
  - M func writeIndex(to: URL) throws

Supporting Types

E DependencyInclusionPolicy
- Enumeration Cases
  - E case all
  - E case exclude([String])
  - E case includeOnly([String])
  - E case none
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ThemeConfiguration
- Initializers
  - M init(accentColour: String, includeDarkMode: Bool, customCSS: String?)
- Instance Properties
- Type Properties
  - P static let `default`: ThemeConfiguration
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S Warning
- Initializers
  - M init(severity: Severity, summary: String, source: SourceLocation?, explanation: String?)
- Instance Properties
- Enumerations
  - E Warning.Severity
    - Enumeration Cases
      - E case note
      - E case warning
    - Initializers
      - M init?(rawValue: String)
    - Default Implementations
      - Equatable Implementations
        
        Operators
        
        static func != (Self, Self) -> Bool
      - RawRepresentable Implementations
        
        Instance Properties
        
        P var hashValue: Int
        
        Instance Methods
        
        M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S SourceLocation
- Initializers
  - M init(file: String, line: Int, column: Int?)
- Instance Properties
  - P let column: Int?
  - P var description: String
  - P let file: String
  - P let line: Int
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool

Structures

S DocLinkPostProcessor
- Initializers
  - M init(documentedModules: [String : String], externalURLs: [String : URL])
- Instance Properties
  - P let documentedModules: [String : String]
  - P let externalURLs: [String : URL]
- Instance Methods
  - M func process(String, currentDepth: Int) -> String
S NavigationIndex
- Structures
  - S NavigationIndex.SchemaVersion
    - Initializers
      - M init(from: any Decoder) throws
    - Instance Properties
      - P let major: Int
      - P let minor: Int
      - P let patch: Int
    - Default Implementations
      - Equatable Implementations
        
        Operators
        
        static func != (Self, Self) -> Bool
- Initializers
  - M init(from: any Decoder) throws
- Instance Properties
- Instance Methods
  - M func allModules(language: String) -> [NavigationNode]
  - M func findModule(String, language: String) -> NavigationNode?
- Type Methods
  - M static func load(from: URL) throws -> NavigationIndex
  - M static func merge([NavigationIndex]) -> NavigationIndex
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S NavigationNode
- Initializers
  - M init(from: any Decoder) throws
- Instance Properties
  - P let children: [NavigationNode]?
  - P var id: String
  - P let isBeta: Bool?
  - P let isDeprecated: Bool?
  - P var isExpandable: Bool
  - P let isExternal: Bool?
  - P var isGroupMarker: Bool
  - P var nodeType: NodeType
  - P let path: String?
  - P let title: String
  - P let type: String?
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S NavigationSidebarBuilder
- Initializers
  - M init(navigationIndex: NavigationIndex)
- Instance Methods
S SwiftSyntaxHighlighter
- Initializers
  - M init()
- Instance Methods
  - M func highlight(String) -> String
S SymbolKind
- Initializers
- Instance Properties
- Type Properties
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
  - RawRepresentable Implementations
    - Instance Properties
      - P var hashValue: Int
    - Instance Methods
      - M func hash(into: inout Hasher)

Enumerations

E NodeType
- Enumeration Cases
  - E case article
  - E case `associatedtype`
  - E case `case`
  - E case `class`
  - E case `deinit`
  - E case dictionary
  - E case `enum`
  - E case `extension`
  - E case `func`
  - E case groupMarker
  - E case `init`
  - E case languageGroup
  - E case `let`
  - E case macro
  - E case method
  - E case module
  - E case namespace
  - E case `operator`
  - E case overview
  - E case property
  - E case `protocol`
  - E case section
  - E case `struct`
  - E case `subscript`
  - E case tutorial
  - E case `typealias`
  - E case union
  - E case unknown
  - E case `var`
- Initializers
  - M init(rawValue: String)
- Instance Properties
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
  - RawRepresentable Implementations
    - Initializers
      - M init(from: any Decoder) throws
    - Instance Properties
      - P var hashValue: Int
    - Instance Methods
      - M func encode(to: any Encoder) throws
      - M func hash(into: inout Hasher)

DocCStaticServer

Classes

C PreviewServer
- Creating a Server
  - M init(rootDirectory: URL, port: Int)
- Running the Server
  - M func run() async throws
- Properties
  - P let rootDirectory: URL
  - P let port: Int
- Default Implementations
  - Actor Implementations
    - Instance Methods

Structures

S HTTPResponse
- Creating Success Responses
  - M static func ok(body: Data, contentType: MIMEType, includeBody: Bool) -> HTTPResponse
- Creating Error Responses
- Response Properties
  - P let head: HTTPResponseHead
  - P let body: ByteBuffer?
S StaticFileHandler
- Creating a Handler
  - M init(rootDirectory: URL)
- Handling Requests
  - M func handleRequest(uri: String, includeBody: Bool) async -> HTTPResponse
- Properties
  - P let rootDirectory: URL

Enumerations

E MIMEType
- Getting MIME Types
  - M static func from(fileExtension: String) -> MIMEType
- Text Formats
  - E case html
  - E case css
  - E case javascript
  - E case plain
  - E case xml
- Application Formats
  - E case json
  - E case pdf
  - E case zip
  - E case octetStream
- Image Formats
  - E case png
  - E case jpeg
  - E case gif
  - E case svg
  - E case webp
  - E case ico
- Font Formats
  - E case woff
  - E case woff2
  - E case ttf
  - E case otf
- Multimedia Formats
  - E case mp4
  - E case webm
  - E case mp3
  - E case wav
- Initializers
  - M init?(rawValue: String)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
  - RawRepresentable Implementations
    - Instance Properties
      - P var hashValue: Int
    - Instance Methods
      - M func hash(into: inout Hasher)

/

DocCStatic Library / NavigationIndex

Property

interfaceLanguages

The navigation trees organised by interface language.

let interfaceLanguages: [String : [NavigationNode]]

swift-docc-static by René Hexel