Skip to content

Update jsdoc template#1202

Merged
codeworrior merged 7 commits intov4from
update-jsdoc-template
Mar 24, 2026
Merged

Update jsdoc template#1202
codeworrior merged 7 commits intov4from
update-jsdoc-template

Conversation

@codeworrior
Copy link
Member

No description provided.

When the JSDoc name for a ManagedObject class differs from its runtime
name (as specified in the extend call), then use the JSDoc name to
calculate the fully qualified names of generated documentation.
Otherwise, JSDoc can't associate the generated documentation with the
class.

Also enhances the check for a mismatch between documented base type and
technical base type. It no longer reports a future error when module:*
syntax is used for the documented base type.

Cherry-picked from UI5/openui5@1bf4429d4.
…nd calls

When an extend call creates a class and when the name of the class is
known and when the extend call's second argument is an object literal,
then ensure that it has a @Lends tag associating the object literal
with the class prototype.

Also logs a future error when the name of an existing @Lends tags
doesn't match the name of the described class.

Cherry-picked from UI5/openui5@daab95d89.
Enables automatic discovery and rendering of documentation sections (FAQ, guides, etc.) from directory structure. Sections are discovered at build time and loaded asynchronously at runtime.

JIRA: BGSOFUIPIRIN-6925
Cherry-picked from UI5/openui5@c71a404cb.
Parameters of constructors/methods/events, which are of typeDefs are now
visualized in DemoKit in expandable Rows of Table: when row is expanded
the properties of the typedef are shown in additional rows of the same
Table.

JIRA: BGSOFUIPIRIN-6935
Cherry-picked from UI5/openui5@1a77603c3.
…for API

reference sections

Implement support for multi-level section structure in API documentation, allowing sections to contain subsections organized in folder hierarchies.

- Sections can now have subsections (e.g., FAQ.md + FAQ/ folder)
- Main section content displays as "Overview" subsection
- Subsection files automatically loaded from matching directories
- Dropdown navigation shows only subsection names, not parent section
- The new dynamic sections/subsections are bookmark-able the page automatically scrolls down to the section

Example structure:
  sections/Component/FAQ.md            "Overview" subsection
  sections/Component/FAQ/Example1.md   "Example1" subsection
  sections/Component/FAQ/Example2.md   "Example2" subsection

JIRA: BGSOFUIPIRIN-6925
Cherry-picked from UI5/openui5@05f6fef35.
@codeworrior codeworrior force-pushed the update-jsdoc-template branch from 7979cc2 to 77649de Compare March 24, 2026 07:48
@codeworrior codeworrior requested a review from a team March 24, 2026 07:49
@codeworrior codeworrior merged commit 8e6f96e into v4 Mar 24, 2026
20 checks passed
@codeworrior codeworrior deleted the update-jsdoc-template branch March 24, 2026 10:02
@codeworrior
Copy link
Member Author

Up-port to V5: UI5/cli#1329

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants