From c66ef25c7dfd0c2a3c4a8aa8eea223fa186c2311 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 14 Apr 2018 11:50:43 -0700 Subject: fixes #303 Flesh out compatible API docs --- docs/man/nn_get_statistic.3compat.adoc | 45 ++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/man/nn_get_statistic.3compat.adoc (limited to 'docs/man/nn_get_statistic.3compat.adoc') diff --git a/docs/man/nn_get_statistic.3compat.adoc b/docs/man/nn_get_statistic.3compat.adoc new file mode 100644 index 00000000..a8129f8d --- /dev/null +++ b/docs/man/nn_get_statistic.3compat.adoc @@ -0,0 +1,45 @@ += nn_get_statistic(3compat) +// +// 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 + +nn_get_statistic - get statistic (stub) + +== SYNOPSIS + +[source,c] +---- +#include + +uint64_t nn_get_statistic(int sock, int stat); +---- + +== DESCRIPTION + +The `nn_get_statistic()` function exists only as a stub, and always returns +zero. + +NOTE: This function is provided for API +<> with legacy _libnanomsg_. +Consider using the relevant <> instead. + +== RETURN VALUES + +Zero. + +== ERRORS + +None. + +== SEE ALSO + +<>, +<> -- cgit v1.2.3-70-g09d2