SwiftDocC
TopicReference

Enumeration

TopicReference

A resolved or unresolved reference to a piece of documentation.

enum TopicReference

Discussion

A reference can exist in one of three states:

It has not yet been resolved.
It has successfully resolved.
It has failed to resolve.

References that have resolved, either successfully or not, are represented by TopicReferenceResolutionResult.

Topics

Topic References

struct UnresolvedTopicReference
An unresolved reference to a documentation node.
struct ResolvedTopicReference
A reference to a piece of documentation which has been verified to exist.
enum TopicReferenceResolutionResult
A topic reference that has been resolved, either successfully or not.
typealias SourceLanguage

Enumeration Cases

Instance Properties

var description: String