Relay-Version: version B 2.10 5/3/83; site utzoo.UUCP
Path: utzoo!mnetor!uunet!seismo!rutgers!ames!hao!noao!mcdsun!fnf
From: fnf@mcdsun.UUCP (Fred Fish)
Newsgroups: comp.sys.amiga
Subject: Re: Structured Design (Not a marketing analysis)
Message-ID: <347@mcdsun.UUCP>
Date: Mon, 3-Aug-87 01:15:17 EDT
Article-I.D.: mcdsun.347
Posted: Mon Aug  3 01:15:17 1987
Date-Received: Tue, 4-Aug-87 01:07:24 EDT
References: <469@cc5.bbn.com.BBN.COM> <1267@killer.UUCP>
Reply-To: fnf@mcdsun.UUCP (Fred Fish)
Organization: Motorola Microcomputer Division
Lines: 32

In article <1267@killer.UUCP> elg@killer.UUCP (Eric Green) writes:
-> [stuff deleted...]
->to know. Requiring internal documentation of every module and data structure
->describing its purpoe, range of values, and parameters is MUCH more useful,
->espcially if the documentation is in a special format such that it can be
->easily extracted via a "sed" script or such in order to make a master
->interface manual....
-> [more stuff deleted...]
->Because I'm always looking for an easier and faster way of doing things. I get
->tired of working on the same old project month after month, and have been
->known to go to ridiculous lengths to find just the right tools to make my job
->easier, so I can go on to newer and better things.

Given the above philosophy (internal documentation in each module and
a way to mechanically get that translated into a external form of
documentation) you should check out my "dex" program on my library
disk 14.  This extracts internal documentation inside C comments, in
the general "manual page" form, and converts it to nroff source.
I haven't used it much in a couple of years, since I've pretty much
been stuck fixing other people's code for about that long, rather
than producing brand new code.  It probably still has a few rough
edges (it was one of my first pieces of C code) but might be a good
base for trying new techniques and features.

P.S.  I got the general idea from the Decus C kit, where the
documentation was kept in the source files.

-Fred
-- 
= Drug tests; just say *NO*!
= Fred Fish  Motorola Computer Division, 3013 S 52nd St, Tempe, Az 85282  USA
= seismo!noao!mcdsun!fnf    (602) 438-3614