diff options
Diffstat (limited to 'docs/ref/api/index.md')
| -rw-r--r-- | docs/ref/api/index.md | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/ref/api/index.md b/docs/ref/api/index.md index 11192e62..f2e01a08 100644 --- a/docs/ref/api/index.md +++ b/docs/ref/api/index.md @@ -1,7 +1,20 @@ # API Reference -This section is a reference guide for the NNG programming interfaces. +This section is a reference guide for the _NNG_ programming interfaces. +It is meant to serve as a refernce, rather than as a tutorial. + +The material here is organized by major areas of functionality. + +Note that unless indicated otherwise, consumers of these interfaces must +include the `nng/nng.h` header file like so: + +```c +#include <nng/nng.h> +``` + +## Chapters - [Messages](msg/) - [Threading and Synchronization](thr/) +- [Logging](logging.md) - [Utility Functions](util/) |