On 9/15/07, Allison Randal <[EMAIL PROTECTED]> wrote: > Paul Cochrane wrote: > > =item Per-entity comments > > > > I've noticed in the source lots of C<FUNCDOC> sections in C-language > > code. Shouldn't this just be plain pod as mentioned in PDD07? This > > would mean that more docs are picked up when we run C<make html>, > > isn't that right? > > Yes, FUNCDOC is deprecated, it just needs a cage cleaner to go through > and edit it out. > i'd rather see FUNCDOC stay. it allows us to specify just the parts of the documentation that we need to, and generates the rest from the source. this allows us to skip
=item void myfunc(does_not, match, source) because it's generated from the source, so is always up to date. i believe source should be the canonical reference, and documentation should follow the Don't Repeat Yourself principle. if there's a way we can make this work with a method other than FUNCDOC, i'm all ears. by the way, why do you consider it deprecated? i haven't heard or read any discussion, so i'm curious as to it's deficiencies. ~jerry
