Align jsdoc template with openui5 #1100
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
codeworrior
force-pushed
the
align-jsdoc-template-with-openui5
branch
from
21089e6 to
88be039
Compare
codeworrior
changed the title
codeworrior
force-pushed
the
align-jsdoc-template-with-openui5
branch
from
33b3e68 to
c840ae8
Compare
codeworrior
changed the title
matz3
approved these changes
Dec 10, 2024
The statement was probably used for debugging purposes so it can be removed. Cherry-picked from SAP/openui5@8be158412.
Improved handling of compound types, including union types (e.g., string | boolean) and array notations (e.g., string[]). This update ensures accurate and efficient identification of built-in types, reducing the likelihood of incorrect links in documentation due to unrecognized types. Cherry-picked from SAP/openui5@2dc53cf86.
This change is a follow-up to the previous commit, which introduced a new, simplified way to handle base types in JSDoc. Cherry-picked from SAP/openui5@e419b0223.
Background: The jsdoc allows to specify multiple types for: - function parameters (including constructor parameters) - function return values - properties of typedefs e.g. typedef sap/ui/performance/Measurement.Entry - UI5 metadata properties Then transformApiJson.js adds those multiple types into the "types" field of the entries of the api.json files for each library Problem: The UI5 Demokit did not correctly display multiple types for UI5 metadata properties e.g. it created a single link for all types that opened the Not Found page Solution: - in transformApiJson.js, assign the "linkedEnabled" flag per type (instead of per group of types). Further, set "linkedEnabled"=true only if the type is a UI5 symbol. - in the UI5 Demokit ApiRef section, for each displayed control property, bind the view to the "types" model field, to ensure all types are covered. Cherry-picked from SAP/openui5@4cd0cc12d.
…omplete` Processing of @Augments, @mixin and @borrows tags might produce new duplicates which are not yet visible during the `parseComplete` event. Moving the cleanup to `processingComplete` fixes this. The merge of the additional data that the UI5 AST visitor collected, is still done in `parseComplete` so that it is available when doclets are cloned during the processing of @Augments, @mixin and @borrows tags. Cherry-picked from SAP/openui5@96f6f095d.
…oercion Cherry-picked from SAP/openui5@e38626c0a.
…penui5 build Adds some more Web APIs to the list of known globals. Cherry-picked from SAP/openui5@a7eb4e6d0.
…sap/ui/base/DataTypes The JSDoc template now detects when a managed property uses a global type name but the type itself has a `module:*` name. In that case, the `module:*` name is used for the generated API documentation. Cherry-picked from SAP/openui5@e4d070423.
Problem: In the API Reference section, the complex types of entities [declared in the jsdoc] are not properly displayed and linked to their composing types. Solution: -- Utilize the existing TypeParser in order to parse the individual simple-types composing a complex type. -- Render as links only the simple-types that correspond to UI5 symbols. Cherry-picked from SAP/openui5@03bb1394d.
…jsdoc-template - structure types require an additional set of curly braces - optional fields in a structure are denoted with a trailing "=" as part of the field name Cherry-picked from SAP/openui5@0cb9f8401.
Cherry-picked from SAP/openui5@9bac0e385.
codeworrior
force-pushed
the
align-jsdoc-template-with-openui5
branch
from
c840ae8 to
0e3d0b8
Compare
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.
No description provided.