./library/lib/xodoc.xotcl

Package/File Information

Package provided: xotcl::xodoc 0.84
Package required: xotcl::staticMetadataAnalyzer
Package required: xotcl::htmllib

Defined Objects/Classes:

ConstraintTokenHTML:
FileTokenHTML:
MetadataTokenHTML: getDocPropertiesHTML, printHTML.
MethodTokenHTML:
ObjTokenHTML:
XODoc: documentFileAsHTML, printHTML, writeFile.

Filename: ./library/lib/xodoc.xotcl

Description:

XOTcl documentation tool. Overloads the command @, which is used as a documentation token.

Class: ConstraintTokenHTML

Class: Class
Heritage: MetadataTokenHTML

Class: FileTokenHTML

Class: Class
Heritage: MetadataTokenHTML

Class: MetadataTokenHTML

Class: Class
Procs/Instprocs: getDocPropertiesHTML, printHTML.

Description:

Instmixin to provide HTML printing. Such instmixins are registered for all token types.

Instprocs

abstract printHTML

Description: Print token to HTML document object
getDocPropertiesHTML

Description: Returns list of properties as HTML.

Class: MethodTokenHTML

Class: Class
Heritage: MetadataTokenHTML

Class: ObjTokenHTML

Class: Class
Heritage: MetadataTokenHTML

Class: XODoc

Class: Class
Procs/Instprocs: documentFileAsHTML, printHTML, writeFile.

Description:

Handler class for building a documentation database

Instprocs

printHTML name

Arguments:	name: name of the html document
Description:	Create HTML documentation object from metadata token

writeFile filename name

Arguments:	filename: file name destination
	name: name of the html document
Description:	Create HTML docuemntation from metadata token and write to file

Procs

documentFileAsHTML file docdir

Arguments:	file: filename of the xotcl file to be documented
	docdir: directory to which the html file is written
Description:	Uses the xoDoc package to produce an HTML documentation of a specified file *.xotcl. The file is written to *.html in docdir
Return:	file basename without suffix

Back to index page.