::tycho::DocSys -
Source File -
Contents:
public methods
- public procs
- protected methods
- protected variables
- protected common
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.
appendConstruct construct comment access argList
generateOutputFile filename
readFile file
resetOutsideClassComment
getDocCommentTag construct tag
getAccess construct
getName construct
getArgs construct
arrayClause comment access argList
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
procClause comment access argList
setClause comment access argList
variableClause comment access argList
unknownClause comment access argList
classList
currentClassIndex 0
outsideClassComment