Add stanza to match variable assignments #8
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
…lare' or 'export' -- more POSIX friendly
Added stanza to match variable assignments. This is specifically to be more useful to POSIX-compliant scripts where 'declare' is not a thing. All variables matched this way are set as type 'String'. Though this does likely match the same variable more than once, that does not appear to be an issue in the end product.
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.
Hello, in writing POSIX-compliant scripts, we are unable to use the 'declare' syntax, thus I have added a stanza to match simple variable assignments. Variables matched in this way are given a type of 'String'. This allows Doxygen to catch and add these to generated documentation. Though it almost certainly results in multiple matches, in my (admittedly limited) testing, the end-result looks fine.
Though this project is 'bash-doxygen' and not 'posix-doxygen', I believe this to be of value to many bash users as well, since it is not really common practice to use the 'declare' keyword from what I have seen.