UnresolvedTopicReference

An unresolved reference to a documentation node.

struct UnresolvedTopicReference

Discussion

You can create unresolved references from partial information if that information can be derived from the enclosing context when the reference is resolved. For example:

The bundle identifier can be inferred from the documentation bundle that owns the document from which the unresolved reference came.
The URL scheme of topic references is always “doc”.
The symbol precise identifier suffix can be left out when there are no known overloads or name collisions for the symbol.

Topics

Initializers

init(parent: ResolvedTopicReference, unresolvedChild: UnresolvedTopicReference)
Creates a new unresolved reference from another unresolved reference with a resolved parent reference.
init(topicURL: ValidatedURL)
Creates a new untitled, unresolved reference with the given validated URL.
init(topicURL: ValidatedURL, title: String)
Creates a new unresolved reference with the given validated URL and title.

Instance Properties

var bundleID: DocumentationBundle.Identifier?
The bundle identifier, if one was provided in the host name component of the original URL.
var description: String
var fragment: String?
The fragment of the unresolved reference, if the original URL contained a fragment component.
var path: String
The path of the unresolved reference.
var title: String?
An optional title.
let topicURL: ValidatedURL
The URL as originally spelled.