diff options
| author | Garrett D'Amore <garrett@damore.org> | 2025-10-08 18:26:51 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2025-10-08 18:26:51 -0700 |
| commit | 86b4524b10b6e9eace01374ce138f8db81c6f3b9 (patch) | |
| tree | 81f6c34f885b5ad7776cd23f0b03fdc31337916b /docs/ref/api | |
| parent | 9c834956456924df7c885ab8b79573721acaff5c (diff) | |
| download | nng-86b4524b10b6e9eace01374ce138f8db81c6f3b9.tar.gz nng-86b4524b10b6e9eace01374ce138f8db81c6f3b9.tar.bz2 nng-86b4524b10b6e9eace01374ce138f8db81c6f3b9.zip | |
Minor doc fixups.
Diffstat (limited to 'docs/ref/api')
| -rw-r--r-- | docs/ref/api/args.md | 6 | ||||
| -rw-r--r-- | docs/ref/api/errors.md | 2 | ||||
| -rw-r--r-- | docs/ref/api/stream.md | 2 |
3 files changed, 5 insertions, 5 deletions
diff --git a/docs/ref/api/args.md b/docs/ref/api/args.md index a40cef94..9b12de9d 100644 --- a/docs/ref/api/args.md +++ b/docs/ref/api/args.md @@ -60,9 +60,9 @@ returned. This function may return the following errors: -- [`NNG_ARG_AMBIGU`]: Parsed option matches more than one specification. -- [`NNG_ARG_MISSING`]: Option requires an argument, but one is not present. -- [`NNG_ARG_INVAL`]: An invalid (unknown) argument is present in _argv_. +- `NNG_ARG_AMBIG`: Parsed option matches more than one specification. +- `NNG_ARG_MISSING`: Option requires an argument, but one is not present. +- `NNG_ARG_INVAL`: An invalid (unknown) argument is present in _argv_. ### Option Specification diff --git a/docs/ref/api/errors.md b/docs/ref/api/errors.md index 5d59d121..b134a645 100644 --- a/docs/ref/api/errors.md +++ b/docs/ref/api/errors.md @@ -75,7 +75,7 @@ future locale-specific strings may be presented instead. | `NNG_EPEERAUTH`<a name="NNG_EPEERAUTH"></a> | 27 | Peer could not be authenticated. | | `NNG_EBADTYPE`<a name="NNG_EBADTYPE"></a> | 30 | Incorrect type. A type-specific function was used for an object of the wrong type. | | `NNG_ECONNSHUT`<a name="NNG_ECONNSHUT"></a> | 31 | Connection shutdown. The connection was shut down and cannot be used. | -| `NNG_ESTOPPED`<a name="NNG_ESTOPPED"></a> | 1000 | Operation stopped. The operation was stopped with [`nng_aio_stop`] or [`nng_aio_close`]. | +| `NNG_ESTOPPED`<a name="NNG_ESTOPPED"></a> | 1000 | Operation stopped. The operation was stopped with [`nng_aio_stop`]. | | `NNG_EINTERNAL`<a name="NNG_EINTERNAL"></a> | 1000 | An unidentifier internal error occurred. | | `NNG_ESYSERR`<a name="NNG_ESYSERR"></a> | 0x10000000 - 0x1FFFFFFF | An unidentified system error occurred. These are errors reported by the operating system. | | `NNG_ETRANERR`<a name="NNG_ETRANERR"></a> | 0x20000000 - 0x2FFFFFFF | An unidentified transport error occurred. | diff --git a/docs/ref/api/stream.md b/docs/ref/api/stream.md index a2427a70..38c6adb8 100644 --- a/docs/ref/api/stream.md +++ b/docs/ref/api/stream.md @@ -36,7 +36,7 @@ The {{i:`nng_stream_send`}} function starts sending data asynchronously over the The data is sent from the scatter/gather vector located in the [`nng_aio`] _aio_, which must have been previously set using [`nng_aio_set_iov`]. -The {{i:`nng_stream_recv`}} function starts receiving data [asynchronously over the stream _s_ +The {{i:`nng_stream_recv`}} function starts receiving data asynchronously over the stream _s_ into the scatter/gather vector located in the [`nng_aio`] _aio_, which must have been previously set using [`nng_aio_set_iov`]. |