SKGenericSwiftDocs

open class SKGenericSwiftDocs<Substructure> : SKGenericResponse<Substructure> where Substructure : SKBaseSubstructure

Represents a generic SourceKitten Swift Documentation request for a Swift file.


                    
                    
                    init(file:compilerArguments:)

Creates a new synchronous SourceKitten Swift Documentation request.

Warning

The request is sent synchronously, so ensure this initializer is not called on the main thread.

Throws

A SKError, if an error occurs.

Swift

public init(file: File, compilerArguments: [String]) throws

`file`	The source file to gather documentation for.
`compilerArguments`	The compiler arguments used to build the module (e.g `["-sdk", "/path/to/sdk"]`).


                    
                    
                    init(filePath:compilerArguments:)

Creates a new synchronous SourceKitten Swift Documentation request.

Warning

The request is sent synchronously, so ensure this initializer is not called on the main thread.

Throws

A SKError, if an error occurs.

Swift

public convenience init(filePath: String, compilerArguments: [String]) throws

`filePath`	The absolute file path to the source file to gather documentation for.
`compilerArguments`	The compiler arguments used to build the module (e.g `["-sdk", "/path/to/sdk"]`).


                    
                    
                    init(filePath:module:)

Creates a new synchronous SourceKitten Swift Documentation request.

Warning

The request is sent synchronously, so ensure this initializer is not called on the main thread.

Swift

public convenience init(filePath: String, module: SKModule) throws

`filePath`	The absolute file path to the source file to gather documentation for.
`module`	The module that contains the source file.


                    
                    
                    init(file:module:)

Creates a new synchronous SourceKitten Swift Documentation request.

Warning

The request is sent synchronously, so ensure this initializer is not called on the main thread.

Throws

A SKError, if an error occurs.

Swift

public convenience init(file: File, module: SKModule) throws

`file`	The source file to gather documentation for.
`module`	The module that contains the source file.


                    
                    
                    init(from:)

Undocumented

Swift

public required init(from decoder: Decoder) throws