Class ::tycho::HTMLDocSys


Inherits: ::tycho::ListDocSys - Source File - Contents: public methods - public proc - public variable
This class generates HTML documentation for an HTML file.

Public constructs

Public Methods

generateClassHTML
Generate one HTML file per class. Each of the HTML files has a header that includes a table of contents and a footer that includes information like the author, the copyright and the version control information.
generateOutsideClassHTML
Generate one HTML file per class that contains constructs that are not part of a class. Each of the HTML files has a header that includes a table of contents and a footer that includes information like the author, the copyright and the version control information.
generateHTMLIndex title
Traverse the classList and generate an index.html file that contains links to each class in the classList.

Public Proc

generateHTML verbose debug generateIndex title filelist
Generate HTML for all the files named in filelist, placing the output in the doc/codeDoc subdirectory.

Public Variable

-verbose 0
If verbose is 1, then document everything, otherwise avoid producing html for constructors and destructors without comments, itk_option add, and private methods and variables.

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.