JSDoc improvements

[Florian Lefebvre]

Template:

/**
 * This is the main important part, describing the thing below.
 * Often I **only** use this (at least in TS where typing is in code).
 *
 * But the following tags come in handy for me too:
 *
 * @param name Description of a function parameter — even with types provided by TypeScript, sometimes it’s handy to provide extra context/description. I don’t use it all the time though.
 *
 * @see Handy for linking to another bit of code or docs sometimes (although you can also do that in the main description probably).
 *
 * @example
 * // For more complex functions I might show some example usage
 * codeInUse()
 *
 * @deprecated Handy because editors will give some nice visual feedback with strikethrough and there’s a chance to give users some guidance on what to do instead.
 */

Thanks @delucis 🙏