From dbc61a5038cacc516a49d00a59a669e2617cff51 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 18 Jun 2020 19:19:06 -0700 Subject: 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. --- docs/man/nng_msg_insert.3.adoc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'docs/man/nng_msg_insert.3.adoc') 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. +// Copyright 2020 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // // This document is supplied under the terms of the MIT License, a @@ -20,9 +20,9 @@ nng_msg_insert - prepend to message body #include 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 -- cgit v1.2.3-70-g09d2