Introduction & Overview

Welcome to the TADS3 Library "Proto-Documentation"!

These pages were generated automatically by a program which reads the TADS3 library files and extracts the declarations and comments found therein.

Frames

The main documentation page consists of four frames:

Header: Located at the top of the page, this frame always contains the same top-level table of contents:
File Index: Located in the upper portion of the left-hand side of the page, this frame always contains a list of the source files from which the documentation was generated. Each line in this index contains two links:
Selecting the file name displays in the Content frame documentation for that entire source file.
Selecting the word "classes" displays in the Item Index frame an index of the classes defined in that file.
Item Index: Located in the lower portion of the left-hand side of the page, this frame contains an index of items which changes depending on what is selected from the File Index or Header.
Content: Taking up most of the right-hand side of the page, this frame contains detailed documentation on an item which was selected from one of the other frames.

Miscellaneous Tips

Many items described in the Content pages include two links on the right-hand side of the page of the form "FileName [line]". Clicking on the file name will display the file documentation. Clicking on the line number will display a copy of the original source file, at the line where the item is defined.
If an item says "no description available", try looking in the source file (click on the line number link). There may be documentation there that the documentation generator didn't pick up.
Methods and other things that are defined using macros aren't listed properly, because the documentation generator doesn't expand macros.
The TADS3 version number is listed at the bottom of each Content page.

The documentation generator was written in C# by Edward L. Stauff. You may direct comments and suggestions on the format of the documentation to ed@mewsic.REMOVE_THIS_SPAMGUARD.com. Please DO NOT complain to me about the content of the documentation; I didn't write it! You can download the latest version of this documentation (which may not be in synch with the latest version of TADS3) as well as the source code for the documentation generator at:

http://www.stauffconsulting.com/tads3doc

Intro	Displays this introduction & overview.
Classes	Displays in the Item Index frame an index of all the classes defined in all the source files.
Objects	Displays in the Item Index frame an index of all the global objects defined in all the source files.
Variables	Displays in the Item Index frame an index of all the global variables defined in all the source files.
Functions	Displays in the Item Index frame an index of all the global functions defined in all the source files.
Macros	Displays in the Item Index frame an index of all the macros defined in all the header (.h) files.
Enums	Displays in the Item Index frame an index of all the enums defined in all the header (.h) files.
Templates	Displays in the Item Index frame an index of all the templates defined in all the header (.h) files.
all symbols	Displays in the Item Index frame a list of "A"-"Z" links, each of which displays in the Content frame an index of all the symbols included in this documentation.