search

PretendoNetwork / pictobox

TypeScript library for interacting with several different image types, including those exclusive to the Wii U and 3DS
GNU Affero General Public License v3.0
2 stars 2 forks source link

[Enhancement]: StreamIn class TSDoc comments #14

Open jonbarrow opened 5 months ago

jonbarrow commented 5 months ago

Checked Existing

What enhancement would you like to see?

Add TSDoc comments to relevant methods in the StreamIn class. TSDoc is used by TypeScript to provide better IntelliSense when using the library in an IDE. TSDoc comments are similar to JSDoc comments, but for TypeScript. They should not be used for type information, but rather used similarly to GoDoc comments in Go.

Using TSDoc we can create IntelliSense such as this within the IDE:

Screenshot_from_2023-09-10_02-08-57 (1)

TSDoc should not aim to be verbose enough to be complete documentation. That should be left for our real library documentation. TSDoc should be only be used for quick references and small examples, if applicable.

Any other details to share? (OPTIONAL)

No response

mysticdev210 commented 1 week ago

I would like to work on this project