aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_close.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-02 15:43:43 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-02 17:02:40 -0800
commitc2deb4a479be750b054372e83154f4b3b051c95a (patch)
treea6909733d8d56fcfa192b16c0c05b07e15e1ad7f /docs/nng_close.adoc
parent4f1029f8f4c582d1f04632b0c50f4c374284fa16 (diff)
downloadnng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.gz
nng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.bz2
nng-c2deb4a479be750b054372e83154f4b3b051c95a.zip
Update markup with simpler copyright and new-style asciidoctor.
Diffstat (limited to 'docs/nng_close.adoc')
-rw-r--r--docs/nng_close.adoc51
1 files changed, 16 insertions, 35 deletions
diff --git a/docs/nng_close.adoc b/docs/nng_close.adoc
index 3475436e..9a582f83 100644
--- a/docs/nng_close.adoc
+++ b/docs/nng_close.adoc
@@ -1,24 +1,19 @@
-nng_close(3)
-============
+= nng_close(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
:manvolnum: 3
-:icons: font
-:source-highlighter: pygments
-:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \
- Copyright 2018 Capitar IT Group BV <info@capitar.com> \
- This software 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
-----
+: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].
+
+== NAME
+
nng_close - close a socket
-SYNOPSIS
---------
+== SYNOPSIS
[source, c]
-----------
@@ -27,9 +22,7 @@ SYNOPSIS
int nng_close(int s);
-----------
-
-DESCRIPTION
------------
+== DESCRIPTION
The `nng_close()` function closes the supplied socket, 's'. Messages
that have been submitted for sending may be flushed or delivered,
@@ -40,32 +33,20 @@ Further attempts to use the socket after this call returns will result
in `NNG_EBADF`. Threads waiting for operations on the socket when this
call is executed may also return with an `NNG_EBADF` result.
-
-RETURN VALUES
--------------
+== RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
-
-ERRORS
-------
+== ERRORS
`NNG_EBADF`:: The socket is already closed or was never opened.
-
-SEE ALSO
---------
+== SEE ALSO
<<nng_setopt#,nng_setopt(3)>>,
<<nng_strerror#,nng_strerror(3)>>,
<<nng#,nng(7)>>
+== COPYRIGHT
-COPYRIGHT
----------
-
-Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] +
-Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV]
-
-This document is supplied under the terms of the
-https://opensource.org/licenses/MIT[MIT License].
+{copyright} \ No newline at end of file