NaturalDocs:: Languages:: Tcl

NaturalDocs::Languages::Tcl

A subclass to handle the language variations of Tcl.

Summary
A subclass to handle the language variations of Tcl.
Tcl’s function syntax is shown below.
Tcl specifies parameters as a space-separated list in braces.

EndOfPrototype

sub EndOfPrototype #(type,
stringRef,
falsePositives)

Tcl’s function syntax is shown below.

proc [name] { [params] } { [code] }

This function creates a false positive to skip the first opening brace.  If there are no parameters, empty braces are usually used, although I don’t know if that’s a hard requirement.

Also, the parameters may have braces within them.  I’ve seen one that used { seconds 20 } as a parameter.

FormatPrototype

sub FormatPrototype #(type,
prototype)

Tcl specifies parameters as a space-separated list in braces.  It’s also possible to nest braces in the parameters.

proc name { param1 param2 { seconds 20 } }

This function makes sure the parameters format correctly.

A class containing the characteristics of a particular programming language for basic support within Natural Docs.
sub EndOfPrototype #(type,
stringRef,
falsePositives)
Tcl’s function syntax is shown below.
sub FormatPrototype #(type,
prototype)
Tcl specifies parameters as a space-separated list in braces.