Improve Javascript Documentation
Closed this issue · 3 comments
benbarnett commented
Blog post?
Wiki?
Better comments in file?
We were talking about using jsDoc comments and then something like dox to generate them as HTML. That's also something that could be picked up on this.
ourmaninamsterdam commented
@benbarnett Better comments in the files would be my preference - with generation via dox. I'm happy to pick this up as a side project when I have downtime, as I need to do the same for the CMS.
benbarnett commented
That'd be great. I did a little spike on it in the early days using dox which may or may not be useful: https://github.com/moneyadviceservice/dough/blob/master/Gruntfile.js
ourmaninamsterdam commented
A decision was made to use jsDoc for docs generation and Gulp to facilitate the running of the task.
#224 implements this.