avocode
Have complete documentation
Would you be against using JSDoc on all the public APIs? Looks like there were already a few JSDoc comments added.
I would be willing to add them in and get a JSDoc config file created.
I'm pro that kind of thing but I remember how bad my experience with JSDoc, YUIDoc and perhaps one more such thing was.
Do you feel otherwise?
I have had poor experiences with most document generators.
I have never used YUIDoc but it looks very similar to JSDoc in a lot of ways. The only differences is that JSDoc checks the doc blocks against the actual code, but at the same time YUIDoc has better output.
I am willing to get YUIDoc working and document the public API. I do have experience with JSDoc though so for me it would be what I am most comfortable with.
It's also a small public API, so it might be worth just hand writing the docs into the readme or wiki.
I am good with any option. Let me know and I will gladly see what I can write up and send in a pull request.
Would you mind doing it with https://github.com/assemble/verb?
It is a bit fresh so you may run into bugs but on the positive note I am very happy that it is being actively developed.
I used it for two or three tiny packages of mine, but only for the readme—I didn't use the API–docs–from–code–comments feature.
Sure thing! Always up for learning a new library and verb looks very interesting, and something I could use myself.
@MitMaro, I've been meaning to do #28 anyway.
Since you're going to go over pretty much the whole code and perhaps add comments, I wanted to clean it up for you with Standard style
I hope you like it.
I have been looking into verb but it's very unstable at the moment and I keep hitting bugs. I will keep working on this, but I feel it's going to take some time.