cubos / sdkgen

[ DEPRECATED, SEE https://github.com/sdkgen/sdkgen ] Tool that aims on solving client-server communication and data layout sharing between server, web, android and ios using a description language also called sdkgen.
MIT License
45 stars 9 forks source link

Feature Request: improve tooling for documentation #6

Open vhfmag opened 6 years ago

vhfmag commented 6 years ago

There is room for at least two improvements there:

lbguilherme commented 6 years ago

Function names and parameters are already passed down to the targets, so Javadoc/Jsdoc should already be able to generate basic documentation (method and parameter names).

There should definitely be support for writing documentation comments on the .sdkgen file and have them passed to the targets (perhaps adjusted to match the expectation of the default target documentation tool)

/* Does stuff
 * @note Use only for X kind of stuff
 * @returns The number of stuff done
 */
function doStuff(): number