> Er.. you can make the transition between code and documentation using
> the /* and */ character sequences.
Sure. That's fine for notes from one programmer to another.
However it's not suitable for the production of quality
manuals for the users of the program (which may be applications
programmers trying to understand compiler functions or may be
system programmers trying to read about system calls).
CWEB concerns itself with interlacing the *documentation*
with the sources. This goes way beyond scattering
*commentary* throughout.
> You can embed manual pages as documentation using perl's pod format.
> [And, of course, pod supports other output formats, such as html or
> latex.]
> Raul
I was talking about this in the context of the Linux kernel.
How much of that is written in PERL?
--
Jim Dennis (800) 938-4078 consulting@starshine.org
Proprietor, Starshine Technical Services: http://www.starshine.org
PGP 1024/2ABF03B1 Jim Dennis <jim@starshine.org>
Key fingerprint = 2524E3FEF0922A84 A27BDEDB38EBB95A
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.rutgers.edu