Class ::tycho::ListDocSys


Inherits: ::tycho::DocSys - Source File - Contents: public methods - public procs - protected methods - protected variables - protected common
Each class in the file has its own DocClass object. Each DocClass object consists of variables that contain constructs of similar types. After we fill in the ListDocSys object, we can query it to produce output.

The reason we need to generate a list is so that we can collect interface and implementation comments in one place. Also, we want to be able to print all the public methods and then all the protected methods etc. in order, and the order in the file might not be the order we want these constructs.

Constructs that are outside of a class and do not belong to a class are documented with the class that follows. If the unknown constructs are at the end of the file, then they are documented with the last class in the file.


Public constructs

Public Methods

appendConstruct construct comment access argList
Append a construct data to the appropriate construct variable.
generateOutputFile filename
Generate List output (used primarily for testing).
readFile file
Read in a file. This is needed to keep track classes have already been printed out.
resetOutsideClassComment

Public Procs

getDocCommentTag construct tag
Return the description tag for a particular construct.
getAccess construct
Return the access field for a particular construct.
getName construct
Return the name for a particular construct.
getArgs construct
Return the arguments for a particular construct.

Protected constructs

Protected Methods

arrayClause comment access argList
Append array data.
bodyClause comment access argList
Append body data.
classClause comment access argList
Append class data.
commentClause comment access argList
Append comment data If we are outside a class, then this comment data is file-wide Note that we don't append desc and expl tag values, we just overwrite any preexisting values.
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
procClause comment access argList
setClause comment access argList
variableClause comment access argList
unknownClause comment access argList

Protected Variables

classList
List of DocClass objects that consist of the classes we have seen.
currentClassIndex 0
The index of the first class in the list that hasn't been printed yet.

Protected Common

outsideClassComment
The file-wide comment is saved here. This is common so that if we define more than one class in a file we can share the data.

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.