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_get_output.adoc | 54 ---------------------------------------- 1 file changed, 54 deletions(-) delete mode 100644 docs/man/nng_aio_get_output.adoc (limited to 'docs/man/nng_aio_get_output.adoc') diff --git a/docs/man/nng_aio_get_output.adoc b/docs/man/nng_aio_get_output.adoc deleted file mode 100644 index a362e0ae..00000000 --- a/docs/man/nng_aio_get_output.adoc +++ /dev/null @@ -1,54 +0,0 @@ -= nng_aio_get_output(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_get_output - return output result - -== SYNOPSIS - -[source, c] ------------ -#include - -void *nng_aio_get_output(nng_aio *aio, unsigned int index); ------------ - -== DESCRIPTION - -The `nng_aio_get_output()` function returns the output result at _index_ -resulting from the asynchronous operation associated with _aio_. - -The type and semantics of output parameters are determined by specific -operations. - -NOTE: If the _index_ does not correspond to a defined output for the operation, -or the operation did not succeed, then the return value will be `NULL`. - -CAUTION: It is an error to call this function while the _aio_ is currently -in use by an active asynchronous operation, or if no operation has been -performed using the _aio_ yet. - -== RETURN VALUES - -The __index__th result of the operation, or `NULL`. - -== ERRORS - -None. - -== SEE ALSO - -<>, -<>, -<>, -<>, -<> -- cgit v1.2.3-70-g09d2