::tycho::Edit
-
Source File -
Contents:
itk_options
- public methods
- public procs
- protected methods
- protected variable
Note that there is both a procedure and a method that will generate
documentation. The gendoc
procedure can be used to
generate documentation for any file, and the file does not have to be
currently opened by tycho. gendoc
is used by the Ptolemy
man command. The gendocBuffer
method is used to generate
documentation for the current contents of a editor. gendoc
and gendocBuffer
both call internal functions
(gendocFileInternal
and gendocBufferInternal
that do the real work. Child classes will usually redefine
gendoc
and gendocBuffer
.
-stringcolor
black
-commentcolor
black
-fixmecolor
black
-keywordcolor
black
-proccolor
black
-classcolor
black
-methodcolor
black
-variablecolor
black
closeParen
paren
commentSelection
fillSelection
gendocBuffer
This is a dummy implementation, it merely copies the current file into a .htm file and displays it. Child classes will probably redefine this method.
help
indentLine
indentSelection
indicateReadOnly
bool
toggleReadOnly
.
keywords
parseNow
start stop
spellCheckTags
uncommentSelection
gendoc
file
file
.
This procedure will probably be redefined in child classes.
gendocFileInternal
file genDocFile genCommand
commentRegexp
gendocBufferInternal
genDocFile genCommand
This method takes two arguments, both of which are eval'd.
In the example below, we open the makefile and then sort it.
set w [::tycho::EditProgram [::tycho::autoName .ep] -file makefile]
$w gendoc {set docfile $root.sort} {exec sort $tail > $docfile}
caseSensitiveKeywords
1