Help

Overview | Index | Help

# How This API Document Is Organized

This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

### Overview

> The Overview page is the front page of this API document and provides a list of all modules with a summary for each. This page can also contain an overall description of the set of modules.

### Module

> Each module, nested module has its own separate page. Each of these pages has three sections consisting of a module description, summary tables, and detailed member descriptions:

> - Module declaration
> - All Known Implementing Modules
> - Module description

> - Nested Module Summary
> - Type Summary
> - Datatype Summary
> - DataConstructor Summary
> - Value Summary
> - Exception Summary

> - Type Detail
> - Datatype Detail
> - DataConstructor Detail
> - Value Detail
> - Exception Detail
> Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

### Index

> The Index contains an alphabetic list of all modules, types, datatypes, data constructors, values and exceptions.

Overview | Index | Help