[Helma-user] New helmadoc/jsdoc based reference

[Chris Zumbrunn]

On Feb 23, 2007, at 18:13 , Chris Zumbrunn wrote:

> On Feb 23, 2007, at 16:29 , Chris Zumbrunn wrote:
>
>> On Feb 23, 2007, at 16:18 , Hannes Wallnoefer wrote:
>>
>>> Thanks, Chris. First impression is very good. Just one minor remark:
>>> for the "ghost" sourcecode, there's probably not much point to
>>> include
>>> the sources in the documentation. Would it be possible to render
>>> these
>>> with the --no-sources option? I guess not, this is an all or nothing
>>> question, since you're probably generating the whole doc in one go?
>>
>> Yes, but I can remove it manually. If we include the docs statically
>> this time around and do not build them automatically trough the ant
>> scripts for now then it is not a big deal do clean this out manually.
>>
>> I'm also rendering a version with all the global objects changed to
>> pseudo prototypes. Like I said before though, not sure whether that
>> will really be less confusing. Maybe I just have to fix all the wrong
>> "static" references manually as well and keep the version without
>> pseudo-prototypes.
>
> I did some tweaking to the JSDoc templates and came up with this
> updated rendering:
>
> http://helma.zumbrunn.net/reference/framework/index.html
>
> This version is rendered without any manual clean up, except for the
> reordering of the list of global properties.

Or we could also do this:

http://helma.zumbrunn.net/reference/welcomestyle/

This is a version with the JSDoc templates modified to use headers  
and footers in the style of the welcome app that is included in the  
Helma package.

Chris