Fix handling of locals #1294
Merged
Fix handling of locals #1294
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
Since Geany 2.0 a lot of those are reported for several languages, including C. Those should usually not be documented, but their parent should be instead, otherwise they "get in the way" of triggering documentation of their parent. Add support for the "local" match rule for local variables, and update the default rules to use the FORWARD policy for them. It's not actually the parent documenting the child, but the effect is the same as the user probably wanted to document the parent rather than the local.
|
LGBI. |
|
@frlan note that this might warrant a point release, because basically using this plugin with 2.0 will crash geany (it might not, but it's effectively more likely to crash than not in real use) Sorry I didn't catch that in time 😕 |
|
@frlan do you plan on making a point-release, given the above-mentioned reasons? |
|
I did not yet plan any – maybe a point-release of Geany would be useful, too – but we should do it. |
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 is a two-parts fix required for usage with 2.0:
8cad88d: Fix a crash when encountering an unknown tag type (e.g. locals)
3af0bf5: Add support for locals, and do something useful with them by default.
Without the first one, triggering documentation generation when a local is the "current" symbol crashes the plugin (and thus Geany).
Without the second one in addition, it's annoying because locals "catch" the generation request, although in most cases they should be skipped.
Both of these are particularly important with 2.0 because we now generate locals for purpose of improved scope completion, and thus we have a lot of them for parsers supporting it (e.g. the C and C++ one, which is the main default target of the plugin).