1.4 API Documentation

This reference manual does not go into great detail on the API of Sh. For example, we do not give full prototypes of all functions. This is because detailed and accurate information is available using HTML documentation generated by doxygen from structured comments in the codebase itself. Precompiled versions of this documentation are available from the Sh website, but you can also generate them yourself from the downloadable distribution.

The documentation generated by structured comments should be considered the definitive reference for all functions, classes, frameworks, and program object generators implemented by the Sh library. Since Sh is still under active development, it is also likely that new functions and classes will be added over time that are not (yet) discussed in this manual.


Note: This manual is available as a bound book from AK Peters, including better formatting, in-depth examples, and about 200 pages not available on-line.