Component IDEDocumentation

This component contains 2 tools
1. CommentScanner - for extract all # comments from old tcl/xotcl code that are not maintained by XOTclIDE
2. Htmml Documentation Generator - Generate html documentation for selecting components using xotclide stucture and appending additional comments

• IDE::CommentScanerBrowser
• IDE::DocGenerator
• IDE::DocGeneratorComponent
• IDE::DocGeneratorMain
• IDE::HtmlGeneratorBrowser

• IDE::DocGenerator
• IDE::DocGeneratorComponent
• IDE::DocGeneratorMain
• IDE::CommentScanerBrowser
• IDE::HtmlGeneratorBrowser

The comment scanner can be used by importing old tcl/xotcl source to XOTclIDE.
The problem is that # comments that are written before method are class
headers are lost be loading (source) scripts.
XOTclIDE use @ (metacommand) for specifing comments (see xotcl documentation).
This tool read scripts and extraxt # comments to internal XOTclIDE comments.

Instprocs:

changeDir {}

createSystemMenu {}

getCommand {}

getComment {}

getTitle {}

readDir {dir}

scane {}

scaneFile {file}

selectAll {}

selectTcl {}

setComment {}

setCommentInstprocClass {}

setCommentObjectClass {}

setCommentProc {}

setCommentProcObject {}

skipComment {}

specificInit {}

warningMessage {text}

newBrowser {}

Base classe for generation html documnetation.

Instprocs:

generate {}

getOutDir {}

componentComment {}

contentClass {class}

contentClasses {}

contentList {args}

contentObject {object}

contentObjectProcs {class}

contentObjects {}

contentProc {group}

contentProcs {}

getOutDir {}

getTitle {}

linkToObject {obj}

localLinkToObject {obj}

mainPageLink {}

makeClassesHierarchyList {classes}

pageContent {}

Used to genarate main index documentation page (index.html)

Instprocs:

componentsList {}

fileNameForComponent {cobj}

generate {}

generateDocForComponent {component}

getOutDir {}

getTitle {}

getUserName {args}

pageContent {}

GUI for specifing html documentation generation

Instprocs:

changeDir {}

createSystemMenu {}

excludeIDE {}

generate {}

readComponents {}

selectAll {}

specificInit {}

newBrowser {}