add support for C++ symbol graphs and namespace symbols #766
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@swift-ci Please test |
patshaughnessy
approved these changes
Dec 7, 2023
| @@ -230,6 +231,8 @@ extension AutomaticCuration { | |||
| /// Add a symbol kind to `KindIdentifier.noPageKinds` if it should not generate a page in the | |||
| /// documentation hierarchy. | |||
| static let groupKindOrder: [SymbolGraph.Symbol.KindIdentifier] = [ | |||
| .namespace, | |||
There was a problem hiding this comment.
Why should this C++ symbol be ordered first? And does the whitespace imply you're going to add more C++ symbol kinds here in a new group?
There was a problem hiding this comment.
I added namespaces at the top in their own pseudo-grouping because they're purely an organizational construct, as opposed to classes, protocols, and other kinds of symbols, which reflect some other aspect of the project's API. Swift and plain Objective-C projects will not come across this, since they won't contain namespace symbols.
This was referenced Dec 8, 2023
|
@swift-ci Please test |
binamaniar
approved these changes
Dec 9, 2023
QuietMisdreavus
force-pushed
the
namespace-symbols
branch
from
abbfe7d to
f79279b
Compare
|
@swift-ci Please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bug/issue #, if applicable: rdar://117904448
Summary
This PR starts adding support for C++ symbol graphs, based on Clang's initial support. For the moment, the
c++symbol language is currently lumped into "Objective-C" alongside C itself; proper standalone support for a "C++" language kind should be coordinated with Swift-DocC-Render to ensure that there is full support.In addition, this PR also introduces support for namespace symbols, as those are new in C++ compared to Objective-C.
Dependencies
swiftlang/swift-docc-symbolkit#65
Testing
As C++ symbol graphs are in a state of preliminary support in Clang (they are currently on the main branch of
llvm/llvm-projectand are being integrated intoapple/llvm-project), a basic symbol graph is included in this PR to test automatic curation. This can be used for testing as follows:Steps:
swift run docc preview 'Tests/SwiftDocCTests/Test Bundles/CxxNamespaces.docc'Foonamespace is properly curated and displayed, with classBarunderneath it.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded