summaryrefslogtreecommitdiff
path: root/docs/man/nng_stat_desc.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-04-08 07:40:06 -0700
committerGarrett D'Amore <garrett@damore.org>2024-04-08 07:40:06 -0700
commitc7f7bcb6e2cfbf66c7fab158b0ac02890243b5bb (patch)
tree5ed428c6d3ba3777dcc8ca073f99fa132e57dc4d /docs/man/nng_stat_desc.3.adoc
parent2806ad76d9c5673b9305cfab00e738941fb7938c (diff)
downloadnng-c7f7bcb6e2cfbf66c7fab158b0ac02890243b5bb.tar.gz
nng-c7f7bcb6e2cfbf66c7fab158b0ac02890243b5bb.tar.bz2
nng-c7f7bcb6e2cfbf66c7fab158b0ac02890243b5bb.zip
Converted stats pages
Diffstat (limited to 'docs/man/nng_stat_desc.3.adoc')
-rw-r--r--docs/man/nng_stat_desc.3.adoc52
1 files changed, 0 insertions, 52 deletions
diff --git a/docs/man/nng_stat_desc.3.adoc b/docs/man/nng_stat_desc.3.adoc
deleted file mode 100644
index e87849d3..00000000
--- a/docs/man/nng_stat_desc.3.adoc
+++ /dev/null
@@ -1,52 +0,0 @@
-= nng_stat_desc(3)
-//
-// 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
-
-nng_stat_desc - get statistic description
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-typedef struct nng_stat nng_stat;
-
-const char *nng_stat_desc(nng_stat *stat);
-----
-
-== DESCRIPTION
-
-The `nng_stat_desc()` function returns a brief, human-readable description
-for the statistic _stat_.
-
-TIP: This description can be used for a tool-tip in user interfaces
-displaying these statistic values.
-
-NOTE: At this time, only English descriptions are provided.
-
-== RETURN VALUES
-
-The description of statistic _stat_.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:libnng.3.adoc[libnng(3)],
-xref:nng_stat_name.3.adoc[nng_stats_name(3)],
-xref:nng_stats_get.3.adoc[nng_stats_get(3)],
-xref:nng_stat.5.adoc[nng_stat(5)],
-xref:nng.7.adoc[nng(7)]