The keywords @param, @see, @return all have special meaning to JavaDoc based
tools (as well as a host of other @commands). In my limited tests of
NaturalDocs it looks like it doesn't support those special meanings- which
is why the front page of the NaturalDocs site says that JavaDoc is still to
be supported (the Roadmap section).

By not supported I mean that it looks like NaturalDocs - if it does anything
with them at all - just copies them verbatim, without using them for
crossreferencing or anything.

I hope that NaturalDocs does get around to supporting JavaDoc, because in my
test of doc tools over the last week or so it looks like the best fit for me
- it actually runs on my Linux server, whereas most other things are either
Mac or PC based or, like as2api, just cause me server errors. I'm trying to
integrate a doc-tool in to our SVN setup (so that nightly up-to-date docs
are built) and am having no luck at all. At the moment I'm having to run
something scheduled on my Windows box to achieve it.

We're not going to switch to NaturalDocs 'natural' commenting style over the
JavaDoc style for the simple reason that more tools, longterm, will support
the JavaDoc tags and I want to retain the flexibility to switch doc tools.
And we've already got a load of code commented in this style. :-)

I used to use Doxygen for this in Java - but to be honest Doxygen's output
for AS2 seems pretty poor - unless I'm missing a config trick somewhere...

Ian

On 1/19/06, ryanm <[EMAIL PROTECTED]> wrote:
>
> > As far as I can see from the front page (Roadmap panel) it doesn't yet
> > support JavaDoc as a style, which is a shame...
> >
>     What doesn't it support?
>
_______________________________________________
Flashcoders mailing list
Flashcoders@chattyfig.figleaf.com
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders

Reply via email to