Skip to content

Add diagnostics for missing/broken Symbol Links in DocC comments, Tutorial and Markdown files #2729

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

Draft
Padmashree06 wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Add diagnostics for missing/broken Symbol Links in DocC comments, Tutorial and Markdown files #2729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
40bc5a5
Add go-definition to Documenatation Language Service
Padmashree06 Aug 5, 2026
29575cb
Add test for go-definition in Documenatation Language Service
Padmashree06 Aug 5, 2026
12fc1ef
Add diagnostics for DocC Symbol Links in DocumentationLanguageService
Padmashree06 Aug 7, 2026
f6fa4f6
Resolve symbol link diagnostics via index
Padmashree06 Aug 2, 2026
90f5b70
Correct relative column and remove unwanted comment
Padmashree06 Aug 3, 2026
515254b
Run language service requests concurrently, instead of sequentially
Padmashree06 Aug 3, 2026
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
5 changes: 3 additions & 2 deletions Sources/DocumentationLanguageService/DocCSymbolInformation.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,11 @@ struct DocCSymbolInformation {
}

func matches(_ link: DocCSymbolLink) -> Bool {
guard link.components.count == components.count else {
guard link.components.count <= components.count else {
return false
}
return zip(link.components, components).allSatisfy { linkComponent, symbolComponent in
let matchingSuffix = components.suffix(link.components.count)
return zip(link.components, matchingSuffix).allSatisfy { linkComponent, symbolComponent in
linkComponent.name == symbolComponent.name && symbolComponent.information.matches(linkComponent.disambiguation)
}
}
Expand Down
Loading