Hi Stephen,
Another advantage of JavaDoc-esque utilities is the ability to
'browse' the inheritance hierarchy, find methods and other important
meta info etc.
This consistent code browsing feature of Javadoc is something I
really miss in Perl. It's one way to handle code complexity. I'm not sure
DocSet is the same thing.
One problem with Javadoc is the need to synchronize it with the
current state of the code.
I don't know if a 'dynamic' documentation utility will be quick
enough but this would be a big improvement on JavaDoc.
NIgel
> Hi,
>
> DocSet looks nice.
> I will look into it more.
>
> However, does it extract metadata from the code?
> or just transform the existing POD doc to a more attractive
> and useful format?
>
> I envision that both are required.
> In fact there are both "business logic" and "presentation"
> layers to this, and I think it would serve the documentation
> effort well to separate these issues.
>
> Javadoc works well because it actually examines the code and
> supplements the code with comments (the "business logic" layer,
> associated with determining metadata about the code).
> Then it creates HTML in a very nice format (the "presentation"
> layer, associated simply with presenting the metadata).
>
> I have begun a module which I might release independently on
> CPAN which extracts metadata from code, comments, and pod.
> I have currently named it "Devel::Metadata".
>
> http://www.officevision.com/pub/Devel-Metadata
> http://www.officevision.com/pub/Devel-Metadata/README
>
> Any thoughts on the usefulness of such a module?
>
> I will then look closer at the presentation aspects again
> such as DocSet and perldocs.
>
> Stephen
>
> At 09:17 AM 8/10/2002 +0800, Stas Bekman wrote:
> >Nigel Hamilton wrote:
> >> HI Stephen,
> >>
> >> Your perldocs2 implementation plan looks great.
> >
> >This system already exists. It's called DocSet and is used to generate
> >all the hyperdocs on perl.apache.org. Soon to be released on CPAN.
> >Currently you can grab it from:
> >http://www.apache.org/~stas/DocSet-0.13.tar.gz
> >
> >But the best way to try it now is to build perl.apache.org docs, see:
> >http://perl.apache.org/download/docs.html
> >
> >
> >__________________________________________________________________
> >Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
> >http://stason.org/ mod_perl Guide ---> http://perl.apache.org
> >mailto:[EMAIL PROTECTED] http://use.perl.org http://apacheweek.com
> >http://modperlbook.org http://apache.org http://ticketmaster.com
> >
> >
>
--
Nigel Hamilton
Turbo10 Metasearch Engine
email: [EMAIL PROTECTED]
tel: +44 (0) 207 987 5460
fax: +44 (0) 207 987 5468
________________________________________________________________________________
http://turbo10.com Search Deeper. Browse Faster.
