Enhancement: reduce errors generated from JSDoc expectations

[igneel64]

Current state:
Currently some minor typos etc are generating couple of warnings/errors when checking compliance with JSDoc.

Changes introduced:
Fix documentation for function definitions that would generate these errors.

[coveralls]

Coverage remained the same at 100.0% when pulling 41cc0b4 on igneel64:jsdoc-method-definition-fixes into 19c810b on danivek:master.

[coveralls]

Coverage remained the same at 100.0% when pulling 69916a7 on igneel64:jsdoc-method-definition-fixes into 19c810b on danivek:master.

[danivek]

Thanks @igneel64 !

Maybe we can add eslint-plugin-jsdoc to enforce jsdoc consistency.

What do you think about it ?

[igneel64]

@danivek Happy to contribute!
Really great that you came up with this plugin, didn't even know it myself!
Checked it up and I think the recommended rules will be just fine and will promote consistency for the project.

I will add the plugin, make the required changes and come back to you.

[igneel64]

@danivek Ready for your review.

[danivek]

Wow, I would not have been so far on adding jsdoc when it was missing. 👍

Big thanks ! @igneel64