Class ::tycho::DocClass


Inherits: ::tycho::TyDoc - Source File - Contents: public methods - public variables
This class contains the data for one class. Each field of a DocSys object contains the respective data for that construct in the class we are documenting.

Public constructs

Public Methods

appendConstruct construct comment \ access argList
Append a construct to the appropriate variable.
getClassName
Return the class name for this class.
mergeAllConstructs
Merge all the constructs Constructs can have an interface defined in the class body, and an implementation defined at the top level. Here, we merge all the top level implementation comments into the class body interface comments.

Public Variables

-comment
-srcFile
-array
-body
-class
-common
-configbody
-constructor
-destructor
-inherit
-itk_option
-method
-option
-private
-protected
-proc
-public
-set
-variable
-outsideOption
We store options and procs that are declared outside of a class here.
-outsideProc
-fileWideDesc
The fileWide description goes here, usually this is from the first line of the file.

Index of classes



Author: Christopher Hylands, John Reekie
Version: @(#)TyDoc.itcl 1.5 12/16/96
Copyright: (c) 1995-1996 The Regents of the University of California.