02.03.2014 Views

Tornado

Tornado

Tornado

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

<strong>Tornado</strong> 2.0<br />

User’s Guide<br />

The first line in a routine’s description (after the source-language-dependent routine<br />

delimiter) is a one-line title in the same format.<br />

Routine descriptions are taken to begin after the routine-title line, whether or not a<br />

DESCRIPTION tag is present explicitly.<br />

Section headings are specified by all-caps strings beginning at a newline and ending with<br />

either a newline or a colon.<br />

Italics, notably including Text variables--that is, words in the documentation that are not<br />

typed literally, but are instead meant to be replaced by some value specific to each<br />

instance of use--are marked in the source by paired angle brackets. Thus, to get the output<br />

textVar, type .<br />

Boldface words are obtained as follows: General mechanism: surround a word with<br />

single quotes in the source. Special words: words ending in “Lib” or in a recognized<br />

filename suffix are automatically rendered in bold. For example, fileName.c, object.o,<br />

myStuff.tcl all appear in boldface.<br />

Simple lists can be constructed by indenting lines in the source from the margin (or from<br />

the comment-continuation character, if one is required in a particular source language).<br />

For example:<br />

line one<br />

line two<br />

Overall Output Conventions<br />

Library descriptions are automatically prefaced by a synopsis of the routines in that<br />

library, constructed from the title lines of all routines.<br />

For most input languages, a SYNOPSIS section is supplied automatically for each routine<br />

as well, extracted from the routine definition in a language-dependent manner specified<br />

in the input meta-syntax tables. Input languages that do not support this have empty<br />

strings for $SYNTAX(declDelim); in such languages, the SYNOPSIS section must be<br />

explicitly present as part of the subroutine comments.<br />

For some languages, the routine definition is also used to create a PARAMETERS section<br />

automatically.<br />

The online form of documentation is assumed to fit into a structure involving a parent file<br />

(which includes a list of libraries) and a routine index. Several of the procedures in this<br />

library require names or labels for these files, in order to include links to them in the<br />

output. The parent file and routine index need not actually exist at the time that<br />

procedures in this library execute.<br />

DESCRIPTION tags are supplied automatically for all description sections, whether or not<br />

the tag is present in the source file.<br />

458

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!