docref

Overview ¶

Command docref writes the API reference of the guide's plugin pages from the plugins themselves: their Go source and plugin.json. A page includes what it writes, so the reference can't drift from the code.

go run ./tools/docref -out ../nimbus-starter/resources/views/native/ref motion

Go signatures don't say what a parameter is for, so a function's comment can, in lines godoc leaves out:

//nimbus:param hz readings a second; 30 if it's 0 or less
//nimbus:returns why it stopped
//nimbus:platforms ios

With no names it does every plugin. It fails on a parameter with no description or a plugin with no test results, so that nothing goes out half-documented.