Documentation target

[vhfmag]

Documentation has been regarded as a must for a while now, but little has been done to plan how that would be implemented. I propose we work in two main functionalities:

• A specification for documentation comments in the sdkgen language (prior art: JSDoc, JavaDoc), compatible with its equivalent in the target languages (namely, Javascript, Java, Kotlin and Swift) + include that documentation on the generated code when transpiling
• A documentation target for sdkgen, that could use some ready-to-use documentation solution (such as Docusaurus an GitBook) for generating publishable, human-friendly documentation

Any thoughts?

[dygufa]

I think that we should first focus on implementing the doc syntax on the sdkgen file + node target at first in order to test. After that is done we can move to implement it in the other targets. At the same time we can start to use something like https://github.com/jsdoc3/jsdoc to generate the website with all the doc or we can also generate manually using a target that can populate a md file that would be parsed by docusaurus (I think this would be the best option).

[dygufa]

I think this issue should become just about the documentation target, considering that the documentation syntax in the sdkgen is already being discussed in the issue #6.