sdkgen icon indicating copy to clipboard operation
sdkgen copied to clipboard

Feature Request: improve tooling for documentation

Open vhfmag opened this issue 8 years ago • 1 comments

There is room for at least two improvements there:

  • Function and parameters signatures are available, so sdkgen could provide that information to the API consumer targets (JSDoc for JS/TS, Javadoc for Java/Kotlin, etc)
  • There could be support for documentation directly on the sdkgen file, that would be passed down to the target files.

vhfmag avatar Feb 16 '18 23:02 vhfmag

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

lbguilherme avatar Feb 17 '18 12:02 lbguilherme