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.

Sign up for GitHub

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

Jump to bottom

Add JSDoc comments to the components and util functions to generate Docs #61

Closed
niloysikdar opened this issue Jul 6, 2022 · 1 comment · Fixed by #83
Closed

Add JSDoc comments to the components and util functions to generate Docs #61

niloysikdar opened this issue Jul 6, 2022 · 1 comment · Fixed by #83
Assignees
@niloysikdar
Labels
5 5 story points GSoC 2022 Issues and Pull Requests under Google Summer of Code 2022 released
Milestone
GSoC 2022 - Sprint I

Comments

@niloysikdar
Copy link
Member

Description:

Outcome:

  • Proper JSDoc comments for all of our components and utility methods
@niloysikdar niloysikdar self-assigned this Jul 6, 2022
@niloysikdar niloysikdar added GSoC 2022 Issues and Pull Requests under Google Summer of Code 2022 5 5 story points labels Jul 6, 2022
@niloysikdar niloysikdar moved this to Todo in React Email Jul 6, 2022
@niloysikdar niloysikdar added this to the GSoC 2022 - Sprint D milestone Jul 6, 2022
@niloysikdar niloysikdar moved this from Todo to In Progress in React Email Aug 1, 2022
niloysikdar added a commit that referenced this issue Aug 12, 2022
@niloysikdar
docs(jsdoc): add JSDoc comments
dd9f773 
Add JSDoc comments for generateEmail utility

Resolves #61

Signed-off-by: Niloy Sikdar <[email protected]>
niloysikdar added a commit that referenced this issue Aug 12, 2022
@niloysikdar
docs(jsdoc): add comments for generateTextEmail
709a2eb 
Add JSDoc comments for generateTextEmail utility

Resolves #61

Signed-off-by: Niloy Sikdar <[email protected]>
niloysikdar added a commit that referenced this issue Aug 12, 2022
@niloysikdar
docs(jsdoc): add comments for generateTextEmailFromHTML
2491ebf 
Add JSDoc comments for genearteTextEmailFromHTML utility

Resolves #61

Signed-off-by: Niloy Sikdar <[email protected]>
niloysikdar added a commit that referenced this issue Aug 12, 2022
@niloysikdar
docs(jsdoc): add comments for sx and makeStyles
02abee5 
Add JSDoc comments for sx and makeStyles utilities

re #61

Signed-off-by: Niloy Sikdar <[email protected]>
niloysikdar added a commit that referenced this issue Aug 12, 2022
@niloysikdar
docs(jsdoc): add comment for BaseStyleProp
449755b 
Add JSDoc comments for BaseStyleProp interface

re #61

Signed-off-by: Niloy Sikdar <[email protected]>
niloysikdar added a commit that referenced this issue Aug 12, 2022
@niloysikdar
docs(jsdoc): add comments for Typography
2d76c72 
Add JSDoc comments for Typography component

re #61

Signed-off-by: Niloy Sikdar <[email protected]>
niloysikdar added a commit that referenced this issue Aug 12, 2022
@niloysikdar
docs(jsdoc): add comments for components
cb6b5a6 
Add JSDoc comments for all of the components

re #61

Signed-off-by: Niloy Sikdar <[email protected]>
@niloysikdar niloysikdar mentioned this issue Aug 12, 2022
Merged
niloysikdar added a commit that referenced this issue Aug 14, 2022
@niloysikdar
feat(typedoc): add typedoc generate config and scripts
1e3bcbe 
Add typedocOptions inside tsconfig and add build script to generate typedoc site

Resolves #61

Signed-off-by: Niloy Sikdar <[email protected]>
Repository owner moved this from In Progress to Done in React Email Aug 21, 2022
Repository owner moved this from In Progress to Done in React Email Aug 21, 2022
github-actions bot pushed a commit that referenced this issue Aug 21, 2022
@semantic-release-bot
chore(release): 1.11.0 [skip ci]
d629549 
# [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 🎉

@niloysikdar niloysikdar moved this from Done to Released in React Email Sep 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@niloysikdar niloysikdar

Labels
5 5 story points GSoC 2022 Issues and Pull Requests under Google Summer of Code 2022 released
Projects
React Email
Status: Released
Milestone
GSoC 2022 - Sprint I
Development

Successfully merging a pull request may close this issue.

feat(jsdoc): add JSDoc comments leopardslab/react-email
2 participants
@agentmilindu @niloysikdar