Path: utzoo!utgpu!news-server.csri.toronto.edu!cs.utexas.edu!samsung!zaphod.mps.ohio-state.edu!uwm.edu!ogicse!cvedc!nosun!qiclab!m2xenix!puddle!p0.f42.n105.z1.fidonet.org!AUBREY.MCINTOSH
From: AUBREY.MCINTOSH@p0.f42.n105.z1.fidonet.org (AUBREY MCINTOSH)
Newsgroups: comp.lang.modula2
Subject: SYSTEM
Message-ID: <4940.263E8650@puddle.fidonet.org>
Date: 27 Apr 90 01:36:00 GMT
Sender: ufgate@puddle.fidonet.org (newsout1.26)
Organization: FidoNet node 1:105/42.0 - Bink of an Aye, Portland OR
Lines: 56



From: aubrey@rpp386.cactus.org (Aubrey McIntosh)
Date: 25 Apr 90 16:14:26 GMT
Organization: vima, Austin TX
Message-ID: <18253@rpp386.cactus.org>
Newsgroups: comp.lang.modula2

In article <4360.2631732F@puddle.fidonet.org>
Ernie.Bokkelkamp@p1.f22.n491.z5.fidonet.org (Ernie Bokkelkamp) writes:
>On 16 Apr 1990 17:42, Peter M. Perchansky (1:273/101@Fidonet) wrote:
>Now on the point of importing and libraries. One facility definitely
missing is a documentation system for Modula-2 libraries.  What I mean is
some kind of utility, that can be used to capture descriptions of modules
and the procedures, etc within, and that can produce a structured printout
(similar to the format as used in the JPI-M2 user manual) of all libraries.
An elegant way to do this could be an "informal" extension to the module 
concept by having a "DOCUMENTATION MODULE" added to the DEFINITION M




O>

*********************************
everywhere I say 'cross reference', I mean the M2Format.exe program. :-)


One thing that I did to handle this was to make creative use of the
cross reference utility provided with Logitech's 3.0 system.  n.b. that
later versions of the cross reference utility have been 'fixed,' (like
fixing a cat--it used to work).

Anyway, I use this structure:

  PROCEDURE
    (* Nifty comment, carefully thought out, well edited *)
    DoStuff ( p1: t1;  pn: tn );

The cross reference utility program has a mode where it lists the
lines of code that define a symbol.  With the above style of commenting
procedures, the alphabetized listing documents what the procedure does,
as well.

-- 
Aubrey McIntosh         "Find hungry samurai." -- The Old Man        
1502 Devon Circle       comp.os.minix, comp.lang.modula2         
Austin, TX 78723 
1-(512)-452-1540  (v)
o



--  
uucp: uunet!m2xenix!puddle!42.0!AUBREY.MCINTOSH
Internet: AUBREY.MCINTOSH@p0.f42.n105.z1.fidonet.org