The TSE3 library provides extensive on-line documentation which is extracted by the KDOC tool.
You must build the TSE3 documentation to access this information.
You do this by entering the src/tse3
directory and
typing make tse3-kdoc
. This builds the main TSE3 API
reference which details every single class in TSE3. You can also
build a reference for each namespace individually, type make
tse3-kdoc-libs
.
The easy way is to do a make tse3-kdoc-all
which builds
both.
You will need to have a copy of KDOC installed that correctly handles namespaces (2.0a35 or later works).
The API reference will only integrate with this set of HTML documentation
files (i.e. the links below will only work)
if the TSE3 library source directory is the same as the build directory
(which it will be for most users). If you typed ./configure
in the TSE3 root directory then you're OK!
The comprehensive KDOC API reference provides the following information.
The indivual namespace references are:
You can remove all of the documentation using
make tse3-kdoc-clean
.