vircadia-metaverse icon indicating copy to clipboard operation
vircadia-metaverse copied to clipboard

Document 'token' API with TSDoc.

Open digisomni opened this issue 3 years ago • 2 comments

https://github.com/vircadia/Iamus/blob/master/docs/API-Tokens.md

Document this API within the code and try to ferry as much relevant information in.

digisomni avatar Oct 04 '21 13:10 digisomni

not sure what this is requesting. Is the issue that the code doesn't have enough comments to make the token interactions clear?

Misterblue avatar Oct 23 '21 15:10 Misterblue

Ah, I should open more issues but in essence I wanted to split up the tasks of documenting the APIs with inline comments into multiple pieces so it doesn't seem like some insurmountable task. Documenting each API is a good start.

In-code comments are best for things like this so changes are more likely to be reflected in documentation.

digisomni avatar Oct 23 '21 15:10 digisomni