chore: fix JSDoc comments in datatype.ts

[pkuczynski]

Refs #203

[Shinigami92]

@ST-DDT could you test out if your api docs generation script can handle this param syntax?

[ST-DDT]

@Shinigami92 No it doesn't work.

The typedoc.json does not contain them either.

[pkuczynski]

@Shinigami92 No it doesn't work.

There is an issue reported on typedoc and a PR with a fix: TypeStrong/typedoc#567

[ST-DDT]

@pkuczynski AFAICT That issue/PR isn't going to be fixed/merged soon and even if it gets merged, it does not solve the problem for us. See TypeStrong/typedoc#1810 (review)

So maybe we should remove the [] for now?

[Shinigami92]

Hey @pkuczynski, I also found out that the usage of square-brackets are not a good idea, cause it could be that JetBrains support it, but Microsoft doesn't support them in VSCode.
So we should try to find a solution to write docs for both worlds.

I also think you are mixing JSDoc and (what I call) TSDoc. It's kinda like JavaDoc vs KotlinDoc, they are similar but not the same.

So what I would suggest is something like

/**
 * @param options.min Lower bound for generated number. Defaults to `0`.
 */

[pkuczynski]

I guess there is no other option than remove those defaults for now, and maybe add them at some point in the future when vscode and typedoc will support them. It's really a shame though, and it displays in the docs much nicer when the default value column is provided for a param vs when the information is embedded in the desc.

[pkuczynski]

Done. Could you please re-review...?