This repository was archived by the owner on Oct 9, 2020. It is now read-only.
JSDoc Format
JSLib uses JSDoc to provide documentation directly inside some IDEs.
Here is an example of how it looks in Visual Studio Code:
- Each piece of JSDoc documentation will have a description. It is delimited from other sections by this emoji: 🔹
- Some of the functions / methods have special quirks to look out for or will be deprecated. This warning section is delimited from other sections with this emoji:
⚠️ - Deprecated features are also indicated with a
@deprecatedtag. - You will always encounter a
@sincetag, which indicates with which version the feature was introduced. - The
@versiontag will tell you that something changed in a certain version. - If a function / method can throw an error, the
@throwstag will tell you when this might happen. - Private class methods will start with an underscore, will be tagged with
@privateand their description will be delimited from other sections with this emoji: ❌. Private methods shouldn't be used, or else something might break.