Re: [Libclc-developers] Re: Suggested documentation format
Status: Planning
Brought to you by:
augestad
|
From: Hallvard B F. <h.b...@us...> - 2003-04-02 10:25:32
|
Jan Engelhardt writes: >> An example first, since that's shorter than the format description. >> (CVS replaces $Id$ below with info about the file.) > > Hm if this is going to be in the C files itself, may using > some sig like POD format does I didn't think of putting it in the C files. POD is nice for that because Perl programs can come in a single file with documentation and program in one file, but we are writing a library which comes with several files anyway. > Hm, after wrting this short reply I realize that one could really USE > pod, I looked at it, but the translators make some assumptions that the text will about Perl rather than C, and it's still more complex than I felt we need. -- Hallvard |