diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-11 22:42:44 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-11 22:42:44 -0700 |
| commit | fce09d4e8774f9623d689865f9e2281c93cfcbe4 (patch) | |
| tree | 4494f75925cbf081350d371cca26d70ba68a2d23 /docs | |
| parent | cb7c44c30278bf6b93944b9294c07566697406f0 (diff) | |
| download | nng-fce09d4e8774f9623d689865f9e2281c93cfcbe4.tar.gz nng-fce09d4e8774f9623d689865f9e2281c93cfcbe4.tar.bz2 nng-fce09d4e8774f9623d689865f9e2281c93cfcbe4.zip | |
more mdbook stuff
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/SUMMARY.md | 2 | ||||
| -rw-r--r-- | docs/ref/api/index.md | 4 | ||||
| -rw-r--r-- | docs/ref/api/thr/index.md | 4 | ||||
| -rw-r--r-- | docs/ref/tran/index.md | 2 |
4 files changed, 8 insertions, 4 deletions
diff --git a/docs/ref/SUMMARY.md b/docs/ref/SUMMARY.md index c68fb2b3..e39a9969 100644 --- a/docs/ref/SUMMARY.md +++ b/docs/ref/SUMMARY.md @@ -1,6 +1,6 @@ # Summary -- [API](./api/index.md) +- [API Reference](./api/index.md) - [Threading and Synchronization](./api/thr/index.md) diff --git a/docs/ref/api/index.md b/docs/ref/api/index.md index 6ad8257f..403045d2 100644 --- a/docs/ref/api/index.md +++ b/docs/ref/api/index.md @@ -1,4 +1,6 @@ -# API +# API Reference + +This section is a reference guide for the NNG programming interfaces. - [Threading and Synchronization](api/thr/) - [Utility Functions](api/util/) diff --git a/docs/ref/api/thr/index.md b/docs/ref/api/thr/index.md index bdd8bef4..5f60ed66 100644 --- a/docs/ref/api/thr/index.md +++ b/docs/ref/api/thr/index.md @@ -4,5 +4,5 @@ These interfaces are likely to be useful when implementing concurrent designs. Furthermore, because NNG itself is based on concurrency, the synchronization primitives are likely to be useful in callback functions and similar situations. -- [nng_cv](nng_cv.md) -- [nng_mtx](nng_mtx.md) +- [nng_cv](nng_cv.md) --- condition variable +- [nng_mtx](nng_mtx.md) --- mutual exclusion lock diff --git a/docs/ref/tran/index.md b/docs/ref/tran/index.md index 25f32a7f..8cefa14b 100644 --- a/docs/ref/tran/index.md +++ b/docs/ref/tran/index.md @@ -1,4 +1,6 @@ # Transports +This section documents transports for Scalabity Protocols implemented by NNG. + - [BSD Socket](socket.md) - [UDP](udp.md) |