|
-ee
command line argument.
explain
keyword.
module Main;
explain "The first line contains the short description (synopsis) for the current context.";
function Test() {
explain "Synopsis for function @this.";
}
class CTest {
explain "Synopsis for class @this.";
test() {
explain "Synopsis for method @this";
}
static Test() {
explain "Synopsis for function @this";
}
}
explain
String contains multiple lines, lines 2..n are assumed to contain a comprehensive description for the current context object
@arg
argName desc : Used to describe an argument if the current context object is a function or method. The tag may occur at most one time for each argument.
@author
string : Used to specify the author of the given object. The tag may occur 0..1 times.
@date
string : Used to describe the history of the given object. The tag may occur 0..n times.
@deprecated
reason : Used to mark the current context object as outdated (i.e. not to be used anylonger in new code). Currently only allowed for functions and methods. The tag may occur 0..1 times.
@return
desc : Used to describe the return type if the current context object is a function or method. The tag may occur 0..1 times.
@since
version : Used to specify since when the current context object has been available. Currently only allowed for functions and methods. The tag may occur 0..1 times.
@this
will be replaced by the name of the current context object
b
, big
, br
, code
, i
, li
, ol
, p
, pre
, small
, u
, ul
`<filename>`
.
tks -ee <myscript> | tks dog
(assuming that dog.tkx/dog.tkp is in the current path)