Sounds like someone's volunteering? Docco documentation has a nice philosophical basis: you should be proud of your code, not hide the implementations. Yes, it is a challenge, and JavaScript/CoffeeScripts more wild, inclusive approach makes it a challenge. Is there a tool where we could put in place more formatted comments and get out more structured documentation? I'd use it, if we can find it.
What's nice in 5.4 is that the total lines of CoffeeScript have dropped, I believe, from lines of JavaScript in 5.3, while being more modern and readable. Even if I had used straight JavaScript instead of CoffeeScript, I believe this would still be so. On Sun, Jan 6, 2013 at 4:49 PM, Bob Harner <bobhar...@gmail.com> wrote: > Maybe it's just me, but I find the docco.coffee documentation format > too linear and not very easy to follow. I much prefer the more > organized, structured style of documentation like > http://api.jquery.com/ uses. > > Regardless, it's great to see some real JavaScript documentation > starting to emerge! > > On Thu, Jan 3, 2013 at 5:05 PM, Howard Lewis Ship <hls...@gmail.com> > wrote: > > Also, I've recently changed the build to generate CoffeeScript > > documentation as well as JavaDocs. Here's a preview based on 5.4-alpha-2: > > > > http://people.apache.org/~hlship/t5api/ > > > > I like having this launch page as a step before jumping into the > > CoffeeScript documentation or JavaDocs ... especially because (as you can > > see) it adds a few "quick links" that will save people a lot of hunting > > around. > > > > I may experiment with making the main body of the page an <iframe> so > that > > after you click link, the main navbar stays in place, and add navigation > to > > get you back (to allow you to easily switch back and forth between > JavaDoc > > and CS docs). > > > > Feedback always encouraged! > > > > -- > > Howard M. Lewis Ship > > > > Creator of Apache Tapestry > > > > The source for Tapestry training, mentoring and support. Contact me to > > learn how I can get you up and productive in Tapestry fast! > > > > (971) 678-5210 > > http://howardlewisship.com > > --------------------------------------------------------------------- > To unsubscribe, e-mail: users-unsubscr...@tapestry.apache.org > For additional commands, e-mail: users-h...@tapestry.apache.org > > -- Howard M. Lewis Ship Creator of Apache Tapestry The source for Tapestry training, mentoring and support. Contact me to learn how I can get you up and productive in Tapestry fast! (971) 678-5210 http://howardlewisship.com
