TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Documenting Object Oriented Class Library From:Beverly Parks <bparks -at- HUACHUCA-EMH1 -dot- ARMY -dot- MIL> Date:Fri, 23 Dec 1994 09:44:36 MST
The following information is very brief, but may at least get
you started on the right track. You'll have to work very closely
with the programmers to get the information you need. The
programmers can also refer you to some specific references
(although they may not know it until you ask them for it!).
The following data is excerpted from the Class Reference Library
section of Borland's Turbo Vision for C++ User's Guide.
(The general idea should apply to Smalltalk as well.)
Each class's entry has a graphical representation of the class's
base classes and immediate derived classes.
| BaseClass |
------------- This section gives a brief synopsis
| of the class. In some cases this is
------------- the only information needed.
| THISCLASS |
DATA MEMBERS section
This section lists all data members for each class,
alphabetically, showing the data member's declaration and an
explantion of its use.
aDatamember SomeType aDatamember;
aDatamember is a data member that holds some
information about this sample class. This text
explains how it functions, what it means, and
how you use it.
MEMBER FUNCTIONS section
This section lists all member functions which are either
newly defined for this class or which override inherited member
constructor ClassName (SomeType aParameter);
The *ClassName* constructor creates an object of
class *ClassName*, setting the aDatamember data
member to aParameter.
zilch virtual void zilch();
*zilch* causes the sample class to perform some
--End of Excerpts--
bparks -at- huachuca-emh1 -dot- army -dot- mil