Gerald Richter wrote: > Since the whole Apache API is well documented in this way, it should be > possible to autogenerate most of the mod_perl API documentation from this > informations. It would be necessary that somebody writes a tool that takes > this informations, brings it together with some manualy maintained pod and > generates the pods out of it. This shouldn't be to hard to do.
Can you please elaborate on this "merging manually maintained pod with autogenerated pod" part? I don't see how this can be done easily. e.g. for this doc that I've added recently: http://perl.apache.org/release/docs/2.0/api/mod_perl-2.0/Apache/Log.html there is very little to be re-used from the apache docs, may be 5%. I guess what we need is sort of a template for the API documentation, which will be automatically filled with autogenerated docs. When such a doc is created for the first time, it's copied away to the place where the final pod should be and filled in with manual craft. This autogenerated file should be stored somewhere, so the next time the doc is autogenerated again (if the Apache API changes) we will be able to create a diff against docs that were autogenerated before (e.g. on every release) and merge manually the changes (notice that the diff is done against the doc autogenerated in the previous time, not the final pod). That's how I see it working. So we keep in cvs: 1) WrapXS/Apache/RequestRec/RequestRec.pod.last 2) WrapXS/Apache/RequestRec/RequestRec.pod 3) docs/api/mod_perl-2.0/Apache/RequestRec.pod 1) autogenerated last time and already merged into 3) 2) generated now, so we can diff 2) against 1) and merge into 3) 3) the real pod, manualy edited. > For the XS genaration stuff there some issue with pTHX_ parameters left, > which I hope to resolve soon. Also the whole stuff for generating constants > is missing yet. Devel::PPPort? Another question I have: In order to use ExtUtils::XSBuilder we need to have it in mod_perl. So does that mean that we cannot use it before mod_perl replaces its proprietary WrapXS with ExtUtils::XSBuilder? And of course we need to discuss the template, but this can be done later when and if we start deploying ExtUtils::XSBuilder. __________________________________________________________________ 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]
