SwiftDocC
NodeURLGenerator

Structure

NodeURLGenerator

struct NodeURLGenerator

Topics

Initializers

init(baseURL: URL?)

Instance Properties

var baseURL: URL
The URL to use as base for all URLs in the bundle.

Instance Methods

func urlForReference(ResolvedTopicReference, fileSafePath: String) -> URL
Returns a URL appropriate for the given reference and file safe path.
func urlForReference(ResolvedTopicReference, lowercased: Bool) -> URL
Returns a URL appropriate for the given reference.

Type Methods

static func fileSafeReferencePath(ResolvedTopicReference, lowercased: Bool) -> String
Returns the reference’s path in a format that is safe for writing to disk.
static func fileSafeURL(URL) -> URL
Patch path components for writing to the file system.
static func pathForSemantic(Semantic, source: URL, bundle: DocumentationBundle) -> String
Returns a string path appropriate for the given semantic node.

Enumerations

enum Path