Basic C++ namespace support #247
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
Recurse into namespaces in _parse_undocumented_block(), and use cursor.semantic_parent recursively to figure out namespace prefix. Signed-off-by: Stephan Lachnit <[email protected]>
Signed-off-by: Stephan Lachnit <[email protected]>
This combines some test input from Stephan Lachnit and myself. Some of the results are likely not what's desired. Not everything appears to get the namespace prefix, for example variables. It's not clear that everything that appears to be missing a namespace prefix should get a prefix either; for example class/struct/union members, or enumerators, as they're nested within a parent that does have the namespace prefix. More than anything, the test documents the status quo, and provides a way to make incremental improvements on top.
2 tasks
|
Also, fixes #209. |
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.
This incorporates @stephanlachnit's work from #211 and adds some tests on top.
Let's be honest, there are still some gaps here. For example, variables within a namespace don't get the namespace prefix in documentation. However, I'm making the argument this is a net positive improvement over the status quo, regardless of those gaps. This is progress. This can be built upon.
The tests added merely check against the current output, not what might be the desired output. I don't even have enough recent experience on modern C++ to say what the desired prefixing would be.
Anyway, unless @stephanlachnit and @BrunoMSantos are vehemently opposed, I'm going to merge this as-is.
Let's just move things forward.