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

feat(jsdoc): add JSDoc comments #83

Merged
merged 9 commits into from
Aug 21, 2022
Merged

Conversation

niloysikdar
Copy link
Member

@niloysikdar niloysikdar commented Aug 12, 2022

This Pull Request covers:

  • Proper JSDoc comments for all of our components and utility methods
  • Add TypeDoc to generate static doc site out of the comments

References:

  1. https://jsdoc.app/about-getting-started.html
  2. https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html

TypeDoc site:

Resolves #61

Signed-off-by: Niloy Sikdar niloysikdar30@gmail.com

Add JSDoc comments for generateEmail utility

Resolves #61

Signed-off-by: Niloy Sikdar <niloysikdar30@gmail.com>
Add JSDoc comments for generateTextEmail utility

Resolves #61

Signed-off-by: Niloy Sikdar <niloysikdar30@gmail.com>
Add JSDoc comments for genearteTextEmailFromHTML utility

Resolves #61

Signed-off-by: Niloy Sikdar <niloysikdar30@gmail.com>
Add JSDoc comments for sx and makeStyles utilities

re #61

Signed-off-by: Niloy Sikdar <niloysikdar30@gmail.com>
Add JSDoc comments for BaseStyleProp interface

re #61

Signed-off-by: Niloy Sikdar <niloysikdar30@gmail.com>
Add JSDoc comments for Typography component

re #61

Signed-off-by: Niloy Sikdar <niloysikdar30@gmail.com>
Add JSDoc comments for all of the components

re #61

Signed-off-by: Niloy Sikdar <niloysikdar30@gmail.com>
@niloysikdar niloysikdar added the GSoC 2022 Issues and Pull Requests under Google Summer of Code 2022 label Aug 12, 2022
Add typedocOptions inside tsconfig and add build script to generate typedoc site

Resolves #61

Signed-off-by: Niloy Sikdar <niloysikdar30@gmail.com>
@agentmilindu agentmilindu merged commit ed36fb3 into main Aug 21, 2022
@agentmilindu agentmilindu deleted the feat/61-add-jsdoc-comments branch August 21, 2022 03:11
github-actions bot pushed a commit that referenced this pull request Aug 21, 2022
# [1.11.0](v1.10.0...v1.11.0) (2022-08-21)

### Features

* **jsdoc:** add JSDoc comments ([#83](#83)) ([ed36fb3](ed36fb3)), closes [#61](#61) [#61](#61) [#61](#61) [#61](#61) [#61](#61) [#61](#61) [#61](#61) [#61](#61)
@github-actions
Copy link

🎉 This PR is included in version 1.11.0 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GSoC 2022 Issues and Pull Requests under Google Summer of Code 2022 released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add JSDoc comments to the components and util functions to generate Docs
2 participants