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.

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

Do not merge/js doc #1164

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Do not merge/js doc #1164

wants to merge 2 commits into from

Conversation

petermuessig
Copy link
Member

No description provided.

@petermuessig petermuessig requested a review from Thodd February 6, 2025 14:05
@petermuessig
Copy link
Member Author

@Thodd :

this morning I discussed with @codeworrior to not patch the api.json and rather create a api-mixin[-xxx].json next to the api.json which can be collected by the jsdoc generation to patch the apis.json with the provided content. Then we can prepare this during the regular build in our existing task and just drop it into the test-resources/%namespace%/designtime location.

@Thodd
Copy link
Collaborator

Thodd commented Feb 7, 2025

Meeting notes

JSDoc / api.json

Mixin

  • How to prevent reimplementation of getter/setter definitions?

    • We don't want to duplicate generic code from the JSDoc plugin
  • Wrapper contains JSDoc comments

    • Pro: Easier regarding api.json genration
    • Con: Rollup might not be able to decouple wrapper modules
      • Idea: If this is true, can we just remove the other comments except for the control wrapper?
      • Questions:
        • Can we guarantee that each control wrapper is contained in a separate module?
  • What is considered public/exposed in a lib?

    • Are dependent (seamless) control wrappers public?
      • e.g. the base class
        • This means the api info must contain the full hierachy
      • What about other related entities, e.g. aggregation types, enums, ...?
        • do they need to be contained in the api.json?
    • Or only the dedicated wrappers?
      • This means we must flatten the API info
      • But what about the related entities?
        • they must also be exposed as a dedicated wrapper

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