You are viewing a plain text version of this content. The canonical link for it is here.
Posted to modperl@perl.apache.org by brian moseley <bc...@maz.org> on 2001/06/20 07:51:39 UTC

fancy perl2html replacement

warning: these questions are completely off list topic, but
i bet they're still interesting to lots of you.

does anybody know if nice fancey pod2html replacements
exist? specifically, i want a tool that generates framesets
with package and class indexes like javadoc does.

also, what's the opinion on extending pod? my method
documentation currently looks like this:

  =head2 METHODS

  =over

  =item new()

  Construct and return an instance.

  =item setFooBar($value)

  Sets the value of the FooBar.

  B<Parameters:>

  =over

  =item $value

  the value to set

  =back

  B<Throws:>

  =over

  =item B<Exception::Class::Base>

  if something goes wrong

  =back

  =back

wouldn't it be nicer to have a set of compact constructs for
code documentation? maybe like so:

  =constructor new()

  Construct and return an instance.

  =method setFooBar($value)

  Sets the value of the FooBar.

  =param $value

  the value to set

  =exception B<Exception::Class::Base>

  if something goes wrong

would enable the fancy javadoc-like tool to easily generate
constructor and method summary and detail lists and to
format all that stuff in attractive and easy to read ways,
rather than having big sets of lists that are semantically
meaningless.

i bet somebody's gonna say "hey, use xml instead!" but then
i lose all the pod support built into tools like makemaker.


Re: [OT] Re: fancy perl2html replacement

Posted by brian moseley <bc...@maz.org>.
neat! thanks for the info.

On Wed, 20 Jun 2001, Stas Bekman wrote:

> On Tue, 19 Jun 2001, brian moseley wrote:
>
> >
> > warning: these questions are completely off list topic, but
> > i bet they're still interesting to lots of you.
>
> You want to take these questions to a list designed especially for this
> purpose: pod-people@perl.org. And check CPAN, there is a bunch of new
> packages extending pod (of course they are all discussed here).
>
> You can check the list's archive here:
>
> http://archive.develooper.com/pod-people@perl.org/
>
> _____________________________________________________________________
> Stas Bekman              JAm_pH     --   Just Another mod_perl Hacker
> http://stason.org/       mod_perl Guide  http://perl.apache.org/guide
> mailto:stas@stason.org   http://apachetoday.com http://eXtropia.com/
> http://singlesheaven.com http://perl.apache.org http://perlmonth.com/
>
>


[OT] Re: fancy perl2html replacement

Posted by Stas Bekman <st...@stason.org>.
On Tue, 19 Jun 2001, brian moseley wrote:

>
> warning: these questions are completely off list topic, but
> i bet they're still interesting to lots of you.

You want to take these questions to a list designed especially for this
purpose: pod-people@perl.org. And check CPAN, there is a bunch of new
packages extending pod (of course they are all discussed here).

You can check the list's archive here:

http://archive.develooper.com/pod-people@perl.org/

_____________________________________________________________________
Stas Bekman              JAm_pH     --   Just Another mod_perl Hacker
http://stason.org/       mod_perl Guide  http://perl.apache.org/guide
mailto:stas@stason.org   http://apachetoday.com http://eXtropia.com/
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/