Xref: utzoo comp.unix.questions:20720 comp.text:6617
Path: utzoo!attcan!uunet!samsung!zaphod.mps.ohio-state.edu!rpi!usenet
From: krf@sol.ral.rpi.edu (Keith R. Fieldhouse)
Newsgroups: comp.unix.questions,comp.text
Subject: Looking for simple docuemtation extractor
Message-ID: <DGA#'-*@rpi.edu>
Date: 20 Mar 90 14:24:14 GMT
Organization: Rensselaer Polytechnic Institute, Troy NY
Lines: 52


Is there a generally available, simple, piece of software that will extract
specially formatted comments from source code (mostly C but others 
would be nice) and produce printable documentation.  What I have in mind
is something like the following:

/*
** .FUNCTION	get-stuff()
** .PURPOSE
**		Does really nifty things really fast and you can 
**		dance to it.
** .PARAMETERS
**		a, integer that tells function what to do
**		b, character that tells function what not to do
** .RETURN
**		OK or ERROR
*/

int get-stuff(a,b)
	int a;
	char b;
...


Which would produce something like

<FF>
Function:
	get-stuff

	Does really nifty things really fast 
        and you can dance to it.

Parameters:
	
	a -- an integer that tells function what to do

etc.

It doesn't have be very sophisticated, tangle/web/weave or info-tex are
really overkill for my purposes.  I'm just looking for something where
the small discipline of documenting important functions correctly
provides the large benefit of printable basic documentation.

Any pointer will be appreciated.

				- Keith
--
Keith R. Fieldhouse				krf@ral.rpi.edu
Center for Intelligent Robotic			(518) 276-6758
Systems for Space Exploration (CIRSSE)	        CII 8313
Rensselaer Polytechnic Institute     Troy, New York   12180-3590