Path: utzoo!utgpu!news-server.csri.toronto.edu!rpi!usc!wuarchive!udel!haven.umd.edu!mimsy!nrl-cmf!ghost From: ghost@nrl-cmf.UUCP (Glenn Host) Newsgroups: comp.unix.programmer Subject: Re: Extracting documentation from C code. Message-ID: <271@ra.nrl-cmf.UUCP> Date: 16 May 91 12:06:12 GMT References: Reply-To: ghost@ra.UUCP (Glenn Host) Distribution: comp Organization: Naval Research Laboratory, Washington, DC Lines: 23 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. Two years ago I had to write such a package to translate C-documentation into text for transfer to a Mac for processing. Before I wrote it, we looked for such a utility but were unsucessful. 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. Good Luck -- Glenn Host - Senior Systems Analyst (ghost@ra.nrl.navy.mil) NRL Code 5800, 4555 Overlook Ave.; Washington, DC 20375 (202) 767-2046 12307 Tigers Eye Court ; Reston, VA 22091 (703) 620-1141 ----- Don't mind me - I don't run the place, I only live here. -----