JSON docs should export more information

[NyakoFox]

For documentation exporting, it'd be best if more information got exported.

For example, function params are exported well, being an array with the name, the type, and the description.

However, sometimes the type can be complex, like instead of Sprite, you have Sprite?. If it ended there, it'd be easy enough to parse, but a real format for that would be better. (ex. maybe an "optional" boolean field?) And then when generics come in, it gets a lot more difficult to parse yourself. The language server has all of this information, it just needs to export it in a format that is represented in JSON, rather than a string that'd require more parsing than necessary.

The main problem I'm running into right now is that, despite function params & returns being exported well, overloads have none of this.

"overloads": [
  "fun(x: number, y: number) -> self",
  "fun(x: number, y: number, sprites: Sprite) -> self",
  "fun(x: number, y: number, w: number, h: number) -> self"
],

With overloads, you're missing the format entirely, and you have to somehow parse all of this yourself, which is far more work than what should be required.

(For context, I'm trying to use JSON exports to create automatic online documentation for a project. My specific use-case shouldn't matter though, as anyone using JSON will most likely run into the same problem...)

[CppCXY]

I feel that the exported documentation has now become API exports, and many people already rely on the current export format. I can't change the existing fields; I can only add new ones. Also, I don't have many ideas about the export format, since I don't use it myself.

[NyakoFox]

If you can't change existing ones, it might be worth adding something like overload_info or something which is an array containing params, returns etc. like functions normally do at their "root" level.

Being honest, I don't really know what you'd use doc JSON exports for OTHER than API exports. It's a machine readable format, but some parts are hard for machines to read... so, sorry if I'm requesting things that are out of scope, but doc exports are ALMOST the perfect solution to "auto generated API references" except it's missing a few things to make that feasible (which is why I opened this issue)