Add JSDoc style documentation

[meganindya]

Add JSDoc style documentation when adding new functions, classes, etc. They help the linter.

We should eventually have everything documented in that manner. Perhaps, at some time in the future we might explore porting to TypeScript, thus increasing the robustness and reliability of the codebase.

[sj00coder]

Sir,for this issue we have to configure the project with JSDoc 3 or do commenting on functions and classes to make batter documentation(it is already configured with JSDoc). @meganindya

[meganindya]

Add comments as

/**
 * @param ...
 * @returns ...
 * @throws ...
 * 

[sj00coder]

On ever javascript file ,on all functions and classes? @meganindya

[meganindya]

anywhere applicable

[meganindya]

some files have

/*
 * @param ...
 * @returns ...
 * @throws ...
 * 

so just gotta add an *

[sj00coder]

I am really sorry,but I cant understand that.But,I really want to work on it Sir.Actually,the documentation of jsdoc is also not so clear. In the,below image,where you want to add * Or change it in the form like below image.

[meganindya]

this

Change /* ... */ to /** ... */

[sj00coder]

ohk sir,thank you.I'll do that

[nikkuAg]

Is this issue still open? I would like to contribute to it.

[ashutosh887]

@walterbender @Gautam-Hegde Should I work on it if it's still not resolved? Please assign this issue to me!

[walterbender]

We don't assign issues, but feel free to make a PR.

[ojuschugh1]

Is this issue still open @walterbender @meganindya ?

Thanks and Regards

[walterbender]

I assume there are still a few situations where it needs updating.

[Karan-Palan]

I assume there are still a few situations where it needs updating.

Yes, I saw the codebase, there are some areas which need this update. I have made a PR regarding this. If the changes I made are correct, I can proceed further making more changes

[Ritika-K7]

Is this issue still open? @walterbender I would like to contribute.

[walterbender]

There may still be a few places where the docs need updating. But please don't duplicate the work from this as-of-yet unmerged PR: https://github.com/sugarlabs/musicblocks/pull/3433

[Ritika-K7]

Okay sir.

[Ritika-K7]

@walterbender I hope this message finds you well. My name is Ritika

I made the changes like this .

I've encountered an issue while attempting to push a new branch with my changes to the repository. Unfortunately, I'm getting a "Permission Denied" error.

Here are some additional details:

• GitHub Username: Ritika-K7
• Repository: musicblocks
• Branch: featureMB

Could you please review my permissions and assist in resolving this issue?

Thank you for your time . I appreciate your help in resolving this matter.

Best regards, Ritika

[Karan-Palan]

@walterbender I hope this message finds you well. My name is Ritika

I made the changes like this .

I've encountered an issue while attempting to push a new branch with my changes to the repository. Unfortunately, I'm getting a "Permission Denied" error.

Here are some additional details:

• GitHub Username: Ritika-K7
• Repository: musicblocks
• Branch: featureMB

Could you please review my permissions and assist in resolving this issue?

Thank you for your time . I appreciate your help in resolving this matter.

Best regards, Ritika

I guess you haven't forked the project and are making commits directly to this repository. Please fork and then commit your changes

[Ritika-K7]

okay sir thank you.

[Karan-Palan]

okay sir thank you.

I am just a freshman and a fellow contributor, so no need to call Sir. Glad I could help