diff options
| author | Garrett D'Amore <garrett@damore.org> | 2020-06-18 19:19:06 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2020-06-18 19:19:06 -0700 |
| commit | dbc61a5038cacc516a49d00a59a669e2617cff51 (patch) | |
| tree | 2b63b03499af29eff7b9c76e352366223ddee1ce /docs/man/nng_msg_insert.3.adoc | |
| parent | 2236819226e579058d9f9fd67f3d684630a40634 (diff) | |
| download | nng-dbc61a5038cacc516a49d00a59a669e2617cff51.tar.gz nng-dbc61a5038cacc516a49d00a59a669e2617cff51.tar.bz2 nng-dbc61a5038cacc516a49d00a59a669e2617cff51.zip | |
Language cleanups in the documentation.
Mostly this is removal of the smart quotes, which were
over-used, and misused, and could have been mistaken to
be pejorative. A few other minor nits were fixed while here.
Diffstat (limited to 'docs/man/nng_msg_insert.3.adoc')
| -rw-r--r-- | docs/man/nng_msg_insert.3.adoc | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/man/nng_msg_insert.3.adoc b/docs/man/nng_msg_insert.3.adoc index ff69b8a4..25f98fce 100644 --- a/docs/man/nng_msg_insert.3.adoc +++ b/docs/man/nng_msg_insert.3.adoc @@ -1,6 +1,6 @@ = nng_msg_insert(3) // -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // // This document is supplied under the terms of the MIT License, a @@ -20,9 +20,9 @@ nng_msg_insert - prepend to message body #include <nng/nng.h> int nng_msg_insert(nng_msg *msg, const void *val, size_t size); -int nng_msg_insert(nng_msg *msg, uint16_t val16); -int nng_msg_insert(nng_msg *msg, uint32_t val32); -int nng_msg_insert(nng_msg *msg, uint64_t val64); +int nng_msg_insert_u16(nng_msg *msg, uint16_t val16); +int nng_msg_insert_u32(nng_msg *msg, uint32_t val32); +int nng_msg_insert_u64(nng_msg *msg, uint64_t val64); ---- == DESCRIPTION @@ -33,9 +33,9 @@ The first function prepends _size_ bytes, copying them from _val_. The remaining functions prepend the specified value (such as _val32_) in network-byte order (big-endian). -TIP: These functions make use of pre-allocated "`headroom`" in the message if -available, so it can often avoid performing any reallocation. -Applications should use this instead of reallocating and copying message +TIP: These functions make use of space pre-allocated in front of the +message body if available, so they can often avoid performing any reallocation. +Applications should use these instead of reallocating and copying message content themselves, in order to benefit from this capability. == RETURN VALUES |
