Documentation

[FGRibreau]

Develop a tool like "check-docs" or "dox-check" to check that at least X% functions are documented per files. Something like jsinspect but for documentation.

Then add an interface to check-build.

PR are welcome for this!

--- Want to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/5733682-documentation?utm_campaign=plugin&utm_content=tracker%2F7304231&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F7304231&utm_medium=issues&utm_source=github).

[MattiSG]

That would be Inch. I discussed adapting it to Node some time ago with its author. @rrrene, how is that going? :)

[FGRibreau]

Really nice! If you adapt it don't hesitate to ping me when it's done :)

[rrrene]

@MattiSG Ah, so sorry I forgot to get back to you regarding NodeJS support!

The state-of-the-art is this: Inch has multi-language capabilities since v0.5.0 and provides basic support for Ruby, Elixir and NodeJS (with NodeJS being the most experimental). For NodeJS I created inch.js, which serves as a wrapper to Inch and can be installed via NPM.

If you have Inch (the RubyGem) installed it will run locally. If not, it will use the API of inch-ci.org to display results. If you want to specify a certain Inch version you have installed (e.g. for testing), you can set the INCH_PATH environment variable. Please note that for larger codebases like Watai, the second option (API of inch-ci.org) does not work yet (I will have to configure the webserver to accept larger request bodies or something like that), so the best option to be an early adopter is to install the latest version of Inch next to inch.js via gem install inch.

Please note that this is really work-in-progress, so if you have any suggestions regarding the evaluations or the JS wrapper or anything else, please feel free to post them here or open an issue. I'm really busy in my none-open-source life right now, but for this I would do my best to find the time to make it work!