Re: Documentation: swarm-symbols

[Rick Riolo]

Along this line, I am pretty sure I posted to this list
a simple perl script to look this information up as-needed, eg

fiore-rlr)findInSwarm.pl Averager

Looking for 'address@hidden' or 'address@hidden'
in files under /s/Swarm/swarm-1.0.5-opt/:
                include/analysis/Averager.h     @interface Averager : 
MessageProbe {
Swarm libs to try:
 analysis

It uses the environment SWARMHOME to decide what version to check,
but that can be overridden with a command line argument to look in some
other version.

The "Swarm libs to try" is sugggesting where in the html online
core libs docs to look for the symbol's doc.
This easily could be changed to look for @deftype @class etc as needed.
I believe this script is in some prior post to the archive.

But maybe the best thing would be to hook some version
of Sven's table into the html doc tree in some convenient place!

 - r

Rick Riolo                           address@hidden
Program for Study of Complex Systems (PSCS)
4068 Randall Lab                
University of Michigan         Ann Arbor MI 48109-1120
Phone: 313 763 3323                  Fax: 313 763 9267
http://www.pscs.umich.edu/PEOPLE/rlr-home.html

On Wed, 13 May 1998, Sven N. Thommesen wrote:

> Date: Wed, 13 May 1998 14:27:05 -0500
> From: Sven N. Thommesen <address@hidden>
> To: address@hidden
> Subject: Documentation: swarm-symbols
> 
> I've often wished I had an index to Swarm symbols and methods, and the lack
> of such was most keenly felt when I upgraded myself to Swarm-1.1 recently.
> While waiting for the promised new, better documentation from the SFI gang,
> I have put together a list of symbols in the Swarm libraries of the
> categories @class, @protocol, @deftype, and @interface, with pointers to
> the source files where they were found. (For those who are new to
> objective-C: in Swarm, @deftype is a synonym for @protocol.)
> 
> I've created two versions of the list, a .txt file which is just a plain
> comma-delimited ASCII file, and an MS-Word97 .doc file where the data have
> been put into a table and sorted alphabetically. You may of course sort the
> data in either file further in ways that are useful to you. Each line has 5
> data fields: symbol name, type, library where found, source file name,
> inheritance. 
> 
> (The list will of course become obsolete as soon as swarm 1.2 is released ;-)
> 
> Marcus has promised to post the uploaded files to the 'anarchy' area on the
> SFI ftp server <ftp://ftp.santafe.edu/pub/swarm/users-contrib/anarchy> .
> There will be two files: swarm-1.1-symbols.tar.gz for the unixoids, and
> swarm_1.1_symbols.zip for the Win32 crowd.
> 
> I hope the info is useful to someone.
> 
> Sven Thommesen
> 
> 
>                   ==================================
>    Swarm-Support is for discussion of the technical details of the day
>    to day usage of Swarm.  For list administration needs (esp.
>    [un]subscribing), please send a message to <address@hidden>
>    with "help" in the body of the message.
>                   ==================================
> 

                  ==================================
   Swarm-Support is for discussion of the technical details of the day
   to day usage of Swarm.  For list administration needs (esp.
   [un]subscribing), please send a message to <address@hidden>
   with "help" in the body of the message.
                  ==================================