Matt Sergeant wrote: > On Wed, 28 Nov 2001, Stas Bekman wrote: > > >>ok, so what you are going to do with other documentation parts which >>aren't exactly API. e.g. DESCRIPTION and extra information for the >>methods, like examples of usage? >> > > DESCRIPTION is the part of the documentation. Examples however should go > in separate tutorials.
so we have to spec it out. Where do you put the general description. I also think we need to spec out the header of each class. I thought we are using pod, than it's simple, but if not, this need to be addressed. >>also where are you going to stick the docs if parts of the project are >>autogenerated? (I don't think p5ee must be XS free) > > That's a tougher question. However luckily XS supports Perl comments > (provided they don't start in the first column), so we might be OK. Not a solution if you use autogenerated XS! Look at mod_perl 2.0. _____________________________________________________________________ Stas Bekman JAm_pH -- Just Another mod_perl Hacker http://stason.org/ mod_perl Guide http://perl.apache.org/guide mailto:[EMAIL PROTECTED] http://ticketmaster.com http://apacheweek.com http://singlesheaven.com http://perl.apache.org http://perlmonth.com/
