Generate doc comment when type alias is hidden #3122
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
If a type is not documented, but a type alias with the same canonical path is, then generate the documentation of the typealias onto the type, since otherwise it would be lost.
jschwe
force-pushed
the
jschwender/3119-typedef-doc
branch
from
27ec386 to
f9984d7
Compare
emilio
reviewed
Feb 9, 2025
| } | ||
| let type_alias_comment = ctx | ||
| .items() | ||
| .filter(|(_id, alias)| { |
There was a problem hiding this comment.
Iterating over all items seems not really fine, performance wise. Can we avoid it somehow?
There was a problem hiding this comment.
Hmm - I think since we are using this fallback for the case where typedef and struct declaration are at the same time, a potential type alias should always be at item_id + 1. I don't think we currently have a way to access the "next" item or do arithmetic on item ids, but this would avoid iterating through all items.
There was a problem hiding this comment.
Maybe we can do it the other way around? During the clang phase, go peek at the typedef's comment? Haven't tried it tho.
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.
If a type is not documented, but a type alias with the same canonical path is, then generate the
documentation of the type alias onto the type, since otherwise it would be lost.
Fixes #3119