Skip to content

Commit ed9ab84

Browse files
committed
Clarify doc comment for OutOfProcessReferenceResolver.declarationFragments
These declaration fragments are directly used to populate `TopicRenderReference.fragmentsVariants` [1], which is described as "The abbreviated declaration of the symbol to display in links" [2]. This change clarifies that the declaration fragments are expected to be the abbreviated declaration fragments. [1]: https://github.com/swiftlang/swift-docc/blob/65aaf926ec079ddbd40f29540d4180a70af99e5e/Sources/SwiftDocC/Infrastructure/External%20Data/OutOfProcessReferenceResolver.swift#L169 [2]: https://github.com/swiftlang/swift-docc/blob/65aaf926ec079ddbd40f29540d4180a70af99e5e/Sources/SwiftDocC/Model/Rendering/References/TopicRenderReference.swift#L50-L53
1 parent 1b4a185 commit ed9ab84

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

Sources/SwiftDocC/Infrastructure/External Data/OutOfProcessReferenceResolver.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -576,6 +576,8 @@ extension OutOfProcessReferenceResolver {
576576
/// Information about the platforms and their versions where the resolved node is available, if any.
577577
public let platforms: [PlatformAvailability]?
578578
/// Information about the resolved declaration fragments, if any.
579+
///
580+
/// This is expected to be an abbreviated declaration for the symbol.
579581
public let declarationFragments: DeclarationFragments?
580582

581583
// We use the real types here because they're Codable and don't have public member-wise initializers.

0 commit comments

Comments
 (0)