Path: utzoo!utgpu!news-server.csri.toronto.edu!rpi!usc!ucsd!chiton!cdl From: cdl@chiton.ucsd.edu (Carl Lowenstein) Newsgroups: comp.unix.programmer Subject: Re: Extracting documentation from C code. Message-ID: <1071@chiton.ucsd.edu> Date: 17 May 91 14:38:15 GMT References: <271@ra.nrl-cmf.UUCP> Reply-To: cdl@chiton (Carl Lowenstein) Distribution: comp Organization: Marine Physical Laboratory, UCSD Lines: 24 In article <271@ra.nrl-cmf.UUCP> ghost@ra.UUCP (Glenn Host) writes: |In article benny@vlss.amdahl.com | (Benny Schnaider) writes: |>I am looking for a utility to extract documentation from a "C" |>program. I want to have the documentation source as part of the "C" code |>(comments) which can be easily extracted in a troff (man page) |>format. The output should be similar to man 3 output format. | |As far as I know there is no such generic utility. | |It is actually easy to write such a utility IF you write before you start |writing the code - otherwise you send almost as much time modifying the |original documents as you would typing them again. It's pretty old, but an organized scheme for keeping documentation in the same file as source code is part of DECUS C. Of course, the doc's were in RUNOFF format, but that's not too bad. There was a program for extracting the document and adding the appropriate RUNOFF headers. DECUS 11-SP-018, as I remember the part number. -- carl lowenstein marine physical lab u.c. san diego {decvax|ucbvax} !ucsd!mpl!cdl cdl@mpl.ucsd.edu clowenstein@ucsd.edu