Instance Method

resolve(_:in:fromSymbolLink:)

Attempt to resolve a TopicReference.

func resolve(_ reference: TopicReference, in parent: ResolvedTopicReference, fromSymbolLink isCurrentlyResolvingSymbolLink: Bool = false) -> TopicReferenceResolutionResult

Parameters

reference: An unresolved (or resolved) reference.
parent: The resolved reference that serves as an enclosing search context, especially the parent reference’s bundle identifier.
isCurrentlyResolvingSymbolLink: If true will try to resolve relative links only in documentation symbol locations in the hierarchy. If false it will try to resolve relative links as tutorials, articles, symbols, etc.

Return Value

Either the successfully resolved reference for the topic or error information about why the reference couldn’t resolve.

Discussion

Note
If the reference is already resolved, the original reference is returned.