Skip to content

Populate symbol kind in external render nodes #1251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Populate symbol kind in external render nodes #1251

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d95e720
Add mapping from documentation kind to symbol kind
anferbui Jul 21, 2025
7a3603b
Capture documentation kind as part of external entity
anferbui Jul 21, 2025
8173968
Propagate symbol kind to navigator for external nodes
anferbui Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion Sources/SwiftDocC/Infrastructure/External Data/OutOfProcessReferenceResolver.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,12 @@ public class OutOfProcessReferenceResolver: ExternalDocumentationSource, GlobalE
imageReferences: (resolvedInformation.references ?? []).compactMap { $0 as? ImageReference }
)

return LinkResolver.ExternalEntity(topicRenderReference: renderReference, renderReferenceDependencies: dependencies, sourceLanguages: resolvedInformation.availableLanguages)
return LinkResolver.ExternalEntity(
topicRenderReference: renderReference,
renderReferenceDependencies: dependencies,
sourceLanguages: resolvedInformation.availableLanguages,
documentationKind: resolvedInformation.kind
)
}

// MARK: Implementation
Expand Down
3 changes: 2 additions & 1 deletion Sources/SwiftDocC/Infrastructure/Link Resolution/ExternalPathHierarchyResolver.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,8 @@ final class ExternalPathHierarchyResolver {
return .init(
topicRenderReference: resolvedInformation.topicRenderReference(),
renderReferenceDependencies: dependencies,
sourceLanguages: resolvedInformation.availableLanguages
sourceLanguages: resolvedInformation.availableLanguages,
documentationKind: resolvedInformation.kind
)
}

Expand Down
10 changes: 8 additions & 2 deletions Sources/SwiftDocC/Infrastructure/Link Resolution/LinkResolver.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,13 @@ public class LinkResolver {
/// - topicRenderReference: The render reference for this external topic.
/// - renderReferenceDependencies: Any dependencies for the render reference.
/// - sourceLanguages: The different source languages for which this page is available.
/// - documentationKind: The kind of external content that's being referenced.
@_spi(ExternalLinks)
public init(topicRenderReference: TopicRenderReference, renderReferenceDependencies: RenderReferenceDependencies, sourceLanguages: Set<SourceLanguage>) {
public init(topicRenderReference: TopicRenderReference, renderReferenceDependencies: RenderReferenceDependencies, sourceLanguages: Set<SourceLanguage>, documentationKind: DocumentationNode.Kind) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a public API, shouldn't we deprecate it and create a new initializer?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't do this because it's experimental API and comes with a warning:

swift-docc/Sources/SwiftDocC/Infrastructure/Link Resolution/LinkResolver.swift

Lines 44 to 45 in 65aaf92

@_spi(ExternalLinks) // This isn't stable API yet.
public struct ExternalEntity {

WDYT? Happy to do as you suggested.

self.topicRenderReference = topicRenderReference
self.renderReferenceDependencies = renderReferenceDependencies
self.sourceLanguages = sourceLanguages
self.documentationKind = documentationKind
}

/// The render reference for this external topic.
Expand All @@ -63,7 +65,11 @@ public class LinkResolver {
var renderReferenceDependencies: RenderReferenceDependencies
/// The different source languages for which this page is available.
var sourceLanguages: Set<SourceLanguage>

/// The kind of external content that's being referenced.
///
/// For example, the navigator requires specific knowledge about what type of external symbol is being linked to.
var documentationKind: DocumentationNode.Kind
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it necessary to store a DocumentationNode.Kind if we only need to access the symbol identifier that's derived from it?


/// Creates a pre-render new topic content value to be added to a render context's reference store.
func topicContent() -> RenderReferenceStore.TopicContent {
return .init(
Expand Down
3 changes: 2 additions & 1 deletion Tests/SwiftDocCTests/Benchmark/ExternalTopicsHashTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ class ExternalTopicsGraphHashTests: XCTestCase {
estimatedTime: nil
),
renderReferenceDependencies: .init(),
sourceLanguages: [.swift]
sourceLanguages: [.swift],
documentationKind: .class
)
return (reference, entity)
}
Expand Down
6 changes: 4 additions & 2 deletions Tests/SwiftDocCTests/Infrastructure/ExternalReferenceResolverTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ class ExternalReferenceResolverTests: XCTestCase {
}
),
renderReferenceDependencies: RenderReferenceDependencies(),
sourceLanguages: [resolvedEntityLanguage]
sourceLanguages: [resolvedEntityLanguage],
documentationKind: resolvedEntityKind
)
}
}
Expand Down Expand Up @@ -707,7 +708,8 @@ class ExternalReferenceResolverTests: XCTestCase {
estimatedTime: nil
),
renderReferenceDependencies: RenderReferenceDependencies(),
sourceLanguages: [.swift]
sourceLanguages: [.swift],
documentationKind: .instanceProperty
)
}
}
Expand Down
3 changes: 2 additions & 1 deletion Tests/SwiftDocCTests/Infrastructure/TestExternalReferenceResolvers.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,8 @@ class TestMultiResultExternalReferenceResolver: ExternalDocumentationSource {
images: entityInfo.topicImages?.map(\.0) ?? []
),
renderReferenceDependencies: dependencies,
sourceLanguages: [entityInfo.language]
sourceLanguages: [entityInfo.language],
documentationKind: entityInfo.kind
)
}
}
6 changes: 4 additions & 2 deletions Tests/SwiftDocCTests/Model/SemaToRenderNodeTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1188,7 +1188,8 @@ class SemaToRenderNodeTests: XCTestCase {
estimatedTime: nil
),
renderReferenceDependencies: .init(),
sourceLanguages: [.objectiveC]
sourceLanguages: [.objectiveC],
documentationKind: .class
)
return (reference, entity)
}
Expand Down Expand Up @@ -1218,7 +1219,8 @@ class SemaToRenderNodeTests: XCTestCase {
estimatedTime: nil
),
renderReferenceDependencies: .init(),
sourceLanguages: [.swift]
sourceLanguages: [.swift],
documentationKind: .collection
)
}
}
Expand Down
2 changes: 2 additions & 0 deletions Tests/SwiftDocCUtilitiesTests/OutOfProcessReferenceResolverTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ class OutOfProcessReferenceResolverTests: XCTestCase {
} else {
XCTFail("Unexpected fragments variant patch")
}

XCTAssertEqual(entity.documentationKind, .init(name: "Kind Name", id: "com.test.kind.id", isSymbol: true))
}

func testResolvingTopicLinkProcess() throws {
Expand Down