aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_msg_alloc.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-25 13:54:40 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-25 13:54:40 -0800
commit545942f7ace7cde8a1b8a6a5289cecc185b08fbc (patch)
tree1bcdcb23828c610026af0e9205f2beaf87a62f7c /docs/nng_msg_alloc.adoc
parent9d3b04f01baf6565ea9e5637a1bd3e54651de307 (diff)
downloadnng-545942f7ace7cde8a1b8a6a5289cecc185b08fbc.tar.gz
nng-545942f7ace7cde8a1b8a6a5289cecc185b08fbc.tar.bz2
nng-545942f7ace7cde8a1b8a6a5289cecc185b08fbc.zip
Better way to handle copyright.
We move the copyright info along with trademark info to the refman layout. The source files still have their own inline copyright (now in correct readable form). This leads towards being able to generate that master reference manual.
Diffstat (limited to 'docs/nng_msg_alloc.adoc')
-rw-r--r--docs/nng_msg_alloc.adoc23
1 files changed, 9 insertions, 14 deletions
diff --git a/docs/nng_msg_alloc.adoc b/docs/nng_msg_alloc.adoc
index 8dd5644d..40f31552 100644
--- a/docs/nng_msg_alloc.adoc
+++ b/docs/nng_msg_alloc.adoc
@@ -1,9 +1,13 @@
= nng_msg_alloc(3)
-:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
- Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
- {blank} + \
- This document is supplied under the terms of the \
- https://opensource.org/licenses/MIT[MIT License].
+//
+// Copyright 2018 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
+// copy of which should be located in the distribution where this
+// file was obtained (LICENSE.txt). A copy of the license may also be
+// found online at https://opensource.org/licenses/MIT.
+//
== NAME
@@ -18,7 +22,6 @@ nng_msg_alloc - allocate a message
int nng_msg_alloc(nng_msg **msgp, size_t size);
-----------
-
== DESCRIPTION
The `nng_msg_alloc()` function allocates a new message with body length _size_
@@ -26,17 +29,14 @@ and stores the result in __msgp__.
Messages allocated with this function contain a body and optionally a header.
They are used with receive and transmit functions.
-
== RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
-
== ERRORS
`NNG_ENOMEM`:: Insufficient free memory exists to allocate a message.
-
== SEE ALSO
<<nng_msg_free#,nng_msg_free(3)>>,
@@ -48,8 +48,3 @@ This function returns 0 on success, and non-zero otherwise.
<<nng_msg_realloc#,nng_msg_realloc(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
<<nng#,nng(7)>>
-
-
-== COPYRIGHT
-
-{copyright}