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

Improving The Documentation to match current Scripts #46

Open
Diwanshumidha opened this issue Dec 23, 2023 · 2 comments
Open

Improving The Documentation to match current Scripts #46

Diwanshumidha opened this issue Dec 23, 2023 · 2 comments

Comments

@Diwanshumidha
Copy link

I would like to improve the documentation for the app

@m-a-mohsen
Copy link

m-a-mohsen commented Dec 23, 2023

What about using jsdoc format?
ex:
`/**

  • Represents a book.
  • @constructor
  • @param {string} title - The title of the book.
  • @param {string} author - The author of the book.
    */
    function Book(title, author) {
    }`
    source: JSDOC

@Diwanshumidha
Copy link
Author

Great Idea

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

No branches or pull requests

2 participants