Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

no attribute should be generated in docs for object type properties #4674

Closed
pskelin opened this issue Feb 1, 2022 · 0 comments · Fixed by #4680
Closed

no attribute should be generated in docs for object type properties #4674

pskelin opened this issue Feb 1, 2022 · 0 comments · Fixed by #4680
Assignees
@ilhan007
Labels
TOPIC Core

Comments

@pskelin
Copy link
Contributor

pskelin commented Feb 1, 2022

Noticed from #4671, the documentation script generates attributes for properties of type object, but it shouldn't.

example:
https://sap.github.io/ui5-webcomponents/playground/components/FlexibleColumnLayout/
Screenshot 2022-02-01 at 13 47 50
@ilhan007 ilhan007 mentioned this issue Feb 1, 2022
Merged
@ilhan007 ilhan007 self-assigned this Feb 1, 2022
ilhan007 added a commit that referenced this issue Feb 2, 2022
@ilhan007
feat(jsdoc): remove attr name for Object props (#4680)
1741bd6 
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
ilhan007 added a commit that referenced this issue Feb 3, 2022
@ilhan007
feat(jsdoc): remove attr name for Object props (#4680)
c607cdd 
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
Assignees

@ilhan007 ilhan007

Labels
TOPIC Core
Projects
Maintenance - Topic Core
Status: Completed
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(jsdoc): remove attr name for Object props SAP/ui5-webcomponents
2 participants
@pskelin @ilhan007