Re: Autogenerated PODs :-)

[Stas Bekman]

Gerald Richter wrote:

1) build: something is missing from README because
xsbuilder/xs_generate.pl was looking for xsbuilder/maps and couldn't
find it. I've added a symlink similar to xsbuilder/xs and then it
worked. shouldn't it look for xsbuilder/xs/maps instead?

makeing the symlink was the right thing to do. I forgot it in the README.
The next version should work without these symlinks, only taking the value
from config.pl, but I didn't had the time to implement it yesterday and I
really wanted this thing o get out...

cool!

2) layout:

Here is a snippet from perldoc's output on Apache/RequestUtil.pm
(indented to the right) with comments starting at /^/:

       Apache::RequestUtil

To save typing would be a good idea to start the functions with:

=head1 Functions

       @func: default_type()

       $ret = $r->default_type()

semicolon would be nice

       @param: Apache::RequestRec $r
           The current request

would be nice to add the markup: C<L<Apache::RequestRec>> C<$r>, or
should this be done at the final conversion stage? It actually should
be
C<L<Apache::RequestRec|docs::2.0::api::mod_perl-2.0::Apache::RequestRec>>

I would do this in the final conversion state, since we decided that this
docs that are generated in stage 1 are only contain content, while the
layout is added in stage 2

Yes, but it'll require special logic for parsing the intermediate formats. This is not needed when you render that format, because you already have the right tokens.

OK, how about the following: let's generate the intermediate and final formats at the same time. This will save us a lot of unnecessary coding and errors.

2.0.1 is an Apache version, Shouldn't this be a mod_perl version?
suppose it should say since: httpd-2.0.1, mod_perl-1.99_apr-0.9.1
whatever is appropriate?

For now this is hardcoded in WrapXS.pm and only a placeholder for some
information that makes more sense. I am not sure how we can get this
information? Any ideas?

should be relatively simple. If the function is going into Apache:: say:

since: apache 2.xx.xx

APR:: say

since: apr 1.xx

ModPerl:: say:

since: mod_perl 2.xx

You already have the versions for apache and apr, for mod_perl can just use the current version. In any case we don't have mod_perl docs that we reuse, so it'll require manual setting of the version.


__________________________________________________________________
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


---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]