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

[doc] Fixing JSDoc #9364

Merged
merged 12 commits into from Dec 11, 2023
Merged

[doc] Fixing JSDoc #9364

merged 12 commits into from Dec 11, 2023

Conversation

heysokam
Copy link
Contributor

@heysokam heysokam commented Dec 1, 2023

Summary

Implements doc-comments for EE's CoreAPI using the JSDoc+TSDoc standards.

  • ComponentFunctions.ts
  • SystemFunctions.tsx

Goal: Write documentation comments in a format that Typedoc can understand and render.

References

QA Steps

@heysokam heysokam added documentation Improvements or additions to documentation rfc Good Start labels Dec 1, 2023
@heysokam heysokam added this to the Tech Debt milestone Dec 1, 2023
@heysokam heysokam self-assigned this Dec 1, 2023
@DanielBelmes DanielBelmes changed the title [doc] Core API documentation with JSDoc+TSdoc+Typedoc [doc] Fixing JSDoc Dec 11, 2023
@DanielBelmes DanielBelmes marked this pull request as ready for review December 11, 2023 19:03
@DanielBelmes DanielBelmes merged commit 15191b8 into dev Dec 11, 2023
13 checks passed
@DanielBelmes DanielBelmes deleted the JSDoc-coreAPI branch December 11, 2023 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation rfc verified-contributor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants