On Dec 11, 2007 11:08 PM, Andy Lester <[EMAIL PROTECTED]> wrote:
> I made it make comment blocks look like this:
>
> /*
>
> =item C<QUEUE_ENTRY * pop_entry>
>
> Does a synchronized removal of the head entry off the queue and
> returns it.
>
> =cut
>
> */
>
> PARROT_CAN_RETURN_NULL
> QUEUE_ENTRY *
> pop_entry(ARGINOUT(QUEUE *queue))
> {
> ... function body...
>
a good start.
> Does anyone actually run something like perldoc src/filename.c to
> look at the docs? I'm thinking that if nobody actually does that, we
> could save the doc discussion until we're actually at a point where
> we're generating docs. Right now, I think that what I've got as the
> prototype above is 90% there, and gets rid of the tons of cut'n'paste
> that are sprinkled throughout the C code.
>
> Let me know your thoughts, so I can do more automation and run it on
> the rest of the source files.
>
nobody really looks at docs in generated .c files, we go to the source
(.pmc, .ops, .in, etc.) why don't you finish the plumbing, and we'll
save the bickering for when the information is flowing everywhere we
need.
once we've decided on a standard doc style, let's document it in PDD07
so it's law.
~jerry
