Reify libclang documentation AST (#26) #227
Merged
Conversation
This file contains 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
TravisCardwell
force-pushed
the
comments-reify
branch
2 times, most recently
from
1ebbb43 to
fbd1202
Compare
edsko
approved these changes
Oct 24, 2024
There was a problem hiding this comment.
@TravisCardwell feel free to merge this once the changes that we discussed are in.
We decided against lenient parsing of `libclang` comments and now throw an error upon encountering an unexpected comment kind, such as block content within inline content. We will of course need to test this against various real-world code. Error messages include the cursor display name, the file name, and the extent. We can investigate the `libclang` comment AST for any errors using the `clang-ast-dump` utility. Note that this internal module is not used anywhere yet, so it is therefore untested. I will test it when returning to the documentation task.
TravisCardwell
force-pushed
the
comments-reify
branch
from
fbd1202 to
04962eb
Compare
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.
See #26 (comment)