Class ::tycho::DocSys


Inherits: ::tycho::TyDoc - Source File - Contents: public methods - protected methods - protected variable - protected common
Read in a file and create an internal representation of the doc comments.

Public constructs

Public Methods

readFile file
Read in a file, and add the files' classes, methods etc. to the DocSys.
parseFileAsList fileAsList
Parse the file and call the appropriate methods for each construct.

Protected constructs

Protected Methods

arrayClause comment access argList
When we find a construct call the appropriate method below Child classes of this class often redefine these methods.
bodyClause comment access argList
classClause comment access argList
commentClause comment access argList
commonClause comment access argList
configbodyClause comment access argList
constructorClause comment access argList
destructorClause comment access argList
inheritClause comment access argList
itk_optionClause comment access argList
methodClause comment access argList
optionClause comment access argList
privateClause comment access argList
protectedClause comment access argList
procClause comment access argList
publicClause comment access argList
setClause comment access argList
variableClause comment access argList
unknownClause comment access argList

Protected Variable

currentFile
The current file that we are reading in.

Protected Common

newlineMagicCookie
At various points, we substitute the value of this variable for newlines.

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.