From 98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 15 Mar 2018 08:40:17 -0700 Subject: fixes #286 nng_pair0_open (and all others) need man page fixes #279 consider restructuring man sections This represents a rather significant rework, and major editing effort, for the entire set of manual pages. All of the pages now have a section number in their filename; this assists in some other tooling, particularly ebook generation as every link needs to be programmatically modified when combined into an ebook. Section 5 is introduced, and populated with pages for the main types, and all options are now documented. Numerous errors have been corrected, including rewriting certain portions such as the header section of the surveyor protocol. Much work has been done to facilitate index generation, although certainly more work remains here. Every internal link within these pages now resolves; there are no more dead links. (This is required to generate Kindle format books.) --- docs/man/nng_aio_result.adoc | 56 -------------------------------------------- 1 file changed, 56 deletions(-) delete mode 100644 docs/man/nng_aio_result.adoc (limited to 'docs/man/nng_aio_result.adoc') diff --git a/docs/man/nng_aio_result.adoc b/docs/man/nng_aio_result.adoc deleted file mode 100644 index 1b55dc0e..00000000 --- a/docs/man/nng_aio_result.adoc +++ /dev/null @@ -1,56 +0,0 @@ -= nng_aio_result(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// 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 - -nng_aio_result - return result of asynchronous operation - -== SYNOPSIS - -[source, c] ------------ -#include - -int nng_aio_wait(nng_aio *aio); ------------ - - -== DESCRIPTION - -The `nng_aio_result()` returns the result of the operation associated -with the handle _aio_. -If the operation was successful, then 0 is returned. Otherwise a non-zero -error code is returned. - -NOTE: The return value from this function is undefined if the operation -has not completed yet. Either call this from the handle's completion -callback, or after waiting for the operation to complete with -<>. - -== RETURN VALUES - -The result of the operation, either zero on success, or an error -number on failure. - -== ERRORS - -`NNG_ETIMEDOUT`:: The operation timed out. -`NNG_ECANCELED`:: The operation was canceled. - -Various other return values are possible dependending on the operation. - -== SEE ALSO - -<>, -<>, -<>, -<>, -<> -- cgit v1.2.3-70-g09d2