feat(jsdoc): remove attr name for Object props #4680
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
vladitasev
approved these changes
Feb 2, 2022
ilhan007
added a commit
that referenced
this pull request
Feb 3, 2022
With this change we enhance the JSDOC parser to automatically omit attribute names for properties of type "Object" or "object". The code literally checks if the type is equal to the "Object" and "object" strings. To complement the auto detection which only checks for the "Object" and "object" strings, we also introduce a new JSDOC tag, called "noattribute" to manually and explicitly tag a member for which the attribute counterpart should not be displayed in the API reference FIXES: #4674
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.
With this change we enhance the JSDOC parser to automatically omit attribute names for properties of type "Object" or "object". The code literally checks if the type is equal to the "Object" and "object" strings.
To complement the auto detection which only checks for the "Object" and "object" strings, we also introduce a new JSDOC tag, called "noattribute" to manually and explicitly tag a member for which the attribute counterpart should not be displayed in the API reference:
After this change the attribute counterpart of the following properties of type Object will be omitted (automatically detected):
accessibilityAttributes
accessibilityTexts
accessibilityRoles
accessibilityTexts
FIXES: #4674