Inline documentation

[Christoph Dorn]

Great job on joose! It is making my JS app much cleaner and easier to
write.

What should I be doing to get inline documentation working? Should
something like JSDoc work or is there a tool available that works
better with Joose?

Christoph

[Malte Ubl]

Hey Christoph,

JSDoc doesnt work so well, because it tries to be smart and fails
badly for Joose code. However, I might be wrong, because there are
multiple forks of JSDoc. You want to have one that does not try static
analysis, but rather just let you write docs.

I don't have a perfect solution right now. Feedback welcome.

I try to pu clever stuff in meta classes, so the remaining code is so
DSL like that it doesn't need any docs :)

Just kidding. Cheers
Malte

[Jeremy Wall]

Personally I tend to just put all the docs in perldoc format and use perls perldoc tools to output them.

[Christoph Dorn]

I am just getting started with Joose, but if I continue to use it (so
far I do not have any reasons not to) I would definitely be interested
in contributing to get proper inline docs working.

How about incorporating something like: http://code.google.com/p/code-illuminated/

Christoph

On May 26, 1:48 pm, Malte Ubl <malte....@gmail.com> wrote:
> Hey Christoph,
>
> JSDoc doesnt work so well, because it tries to be smart and fails
> badly for Joose code. However, I might be wrong, because there are
> multiple forks of JSDoc. You want to have one that does not try static
> analysis, but rather just let you write docs.
>
> I don't have a perfect solution right now. Feedback welcome.
>
> I try to pu clever stuff in meta classes, so the remaining code is so
> DSL like that it doesn't need any docs :)
>
> Just kidding. Cheers
> Malte
>
> On Tue, May 26, 2009 at 10:40 PM, Christoph Dorn
>

[Nickolay Platonov]

Hi Christoph,

Currently there is no tool, designed specially for Joose.

Though you may try to look at this tool from jsdoc family: ext-doc
Its results looks like this: http://extjs-ux.org/ext-docs/?class=Test.Run

Also there are certain plans (in the JSAN project) to create a common JS documentation tool,
which will support parsing from several formats: (JSDoc, POD and MultiMarkdown).

Nickolay