Hopbot log for 2007-08-27 - Helma IRC channel: #helma on irc.freenode.net

2007-08-27:

[5:05] <aiba> anyone know which version of JSDoc is used to generate the helma reference?
[6:56] <zumbrunn> aiba, I'm currently using jsdoc-1.10.2
[6:59] <zumbrunn> btw, I've proposed to change to using jsdoc2, the rhino based jsdoc toolkit, and dump the perl based jsdoc
[6:59] <aiba> what source files are you using to generate the docs for things like app, res, req?
[6:59] <zumbrunn> the perl based jsdoc tends to cause segfaults
[7:00] <aiba> i'm curious because i'm trying to recreate this kind of documentation for my own javascript libraries, but i can't get it to look as good as helma's :)
[7:00] <zumbrunn> http://adele.helma.org/source/viewcvs.cgi/reference/
[7:01] <aiba> sweet, thanks!
[7:02] <aiba> oh, so these are like rhino scriptable objects implemented in java, and you maintain the documentation separately in fake JS files?
[7:02] <zumbrunn> currently, yes
[7:03] <zumbrunn> I suggest you use the jsdoc toolkit instead of jsdoc
[7:03] <zumbrunn> http://jsdoctoolkit.org/
[7:03] <zumbrunn> I wouldn't start a new project based on the perl implementation anymore
[7:03] <aiba> hmmm, i tried that one but went back to jsdoc for some reason
[7:04] <zumbrunn> do you remember why?
[7:04] <aiba> i'm re-running it and trying to figure that out
[7:05] <zumbrunn> :-)
[7:06] <aiba> ah yes, for things like response where you have a singleton object not to be instantiated by the client, i can't figure out how to get it to not display "constructor summary"
[7:08] <aiba> session.js for example tells it to @ignore the constructor, but if you do this in jsdoc_toolkit, it spits an error, " WARNING: Member 'path' documented but no documentation exists for parent object"
[7:08] <aiba> and then refuses to document the object at all
[7:08] <zumbrunn> I'll likely have the same kind of trouble
[7:09] <zumbrunn> did you ask Michael about this on the jsdoc-2 group?
[7:09] <aiba> although i suppose i'm much more likely to improve the source to jsdoc_toolkit than try to remember how to program perl
[7:10] <zumbrunn> exactly
[7:10] <aiba> no, i've just been playing around with this tonight
[7:10] <aiba> i'll take your advice, though, and proceed with jsdoc_toolkit
[7:11] <zumbrunn> if you search the archive you might even already find the solution
[7:11] <aiba> the constructor summary is not a dealbreaker
[7:11] <zumbrunn> http://groups.google.com/group/jsdoc-2
[7:13] <zumbrunn> (I remember there is a @singleton tag, but I don't remember what it does)
[7:14] <aiba> ooh, that would be useful
[7:17] <aiba> in jsdoc_toolkit, tagging a class "@static" causes it to suppress the Constructor Summary section. bingo.
[20:32] <rjb> chris, something's not right with the rss feed of your mochazone
[20:33] <midnightmonster> true that. tried to live bookmark it a while ago--no love.
[20:35] <rjb> <link>/mochazone/Hold+the+whole+program+in+your+head%2C+and+you+can+manipulate+it+at+will/</link>
[20:36] <rjb> i'm no expert but at least my feed reader doesn't like non-absolute url's in <link>
[20:38] <rjb> while it doesn't barf, it has the idea they should be prefixed with file:// and interprets them as such
[20:39] <midnightmonster> firefox live bookmark barfs--comes up with no entries
[22:40] <zumbrunn> hmm, thanks for pointing out the rss trouble

 

 

In the channel now:

Logs by date: