From 0ddaee41ec753805fa12eeabd679870802528dac Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Tue, 29 May 2018 17:03:51 -0700 Subject: fixes #495 SEE ALSO should use [align=left] fixes #494 ERRORS section should use [horizontal] These changes address some basic formatting consistency things, and ultimately (when combined with other tooling changes that are not part of this repo) lead to vastly improved layout in the printed documentation. While here we removed trailing whitespace, and did certain other minor markup tweaks. --- docs/man/nng_msg_header_chop.3.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'docs/man/nng_msg_header_chop.3.adoc') diff --git a/docs/man/nng_msg_header_chop.3.adoc b/docs/man/nng_msg_header_chop.3.adoc index 78625365..6536b6fb 100644 --- a/docs/man/nng_msg_header_chop.3.adoc +++ b/docs/man/nng_msg_header_chop.3.adoc @@ -27,7 +27,7 @@ int nng_msg_header_chop_u32(nng_msg *msg, uint32_t *val32); == DESCRIPTION The `nng_msg_header_chop()` and `nng_msg_header_chop_u32()` functions remove -data from the end of the header of message _msg_. +data from the end of the header of message _msg_. The first function removes _size_ bytes. The second function removes 4 bytes, and stores them in the value _val32_, after converting them from network-byte order (big-endian) to native @@ -39,10 +39,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EINVAL`:: The message header is too short to remove the requested data. == SEE ALSO +[.text-left] <>, <>, <>, -- cgit v1.2.3-70-g09d2