Implement JSDocs

[rabrennie]

Implement JSDocs

[Rabrennie]

Yeah I agree. I don't know what we'll do for all the functions that are already there though.

[gytdau]

I'm not sure about having forced documentation. I feel like it would take out the fun of it for many of the joke functions, which anything.js has a lot of.

I would prefer optional documentation - some functions are more 'serious' and in that case documentation would be suitable.

[dstrekelj]

You can always put off merging pull requests that lack proper commenting until the contributor adds them. Especially if the contribution is large and / or complex.

A good first step would be adding a rule about commenting code to the contributing guidelines.

[gytdau]

My opinion is simple: we shouldn't reject code without documentation. Having a rule that forces documentation would, in my opinion, violate the spirit of anything.js.

[Rabrennie]

I think for the time being I will add the ability to auto generate docs from available jsdocs but not force it on users.

[developer787]

anything should be as organic as possible. It will "slowly" grow and evolve into and organized API.

[vccortez]

I think it would be cool to enable auto generated JSDocs.

That way, the developers themselves could implement the doc of their functions if they want it.

[RamonGebben]

Pull request ready #240

[Rabrennie]

done