From f4de6b5302df8befbd2b229b701d0bf9ca81a5fb Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Wed, 14 Mar 2018 15:19:26 -0700
Subject: Markup changes, started adding type documentation.

---
 docs/man/nng_duration.adoc | 49 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 docs/man/nng_duration.adoc

(limited to 'docs/man/nng_duration.adoc')

diff --git a/docs/man/nng_duration.adoc b/docs/man/nng_duration.adoc
new file mode 100644
index 00000000..e4417609
--- /dev/null
+++ b/docs/man/nng_duration.adoc
@@ -0,0 +1,49 @@
+= nng_duration(5)
+//
+// 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_duration - relative time in milliseconds
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+typedef int32_t nng_duration;
+
+#define NNG_DURATION_INFINITE (-1)
+#define NNG_DURATION_DEFAULT  (-2)
+#define NNG_DURATION_ZERO     (0)
+-----------
+
+== DESCRIPTION
+
+An ((`nng_duration`))(((duration))) is a relative time, measured in
+milliseconds.
+This type is most often used in conjuction with timers and timeouts.
+
+A couple of special values have been set aside, and carry special meanings.
+
+[[NNG_DURATION_DEFAULT]]((`NNG_DURATION_DEFAULT`)):::
+Indicates a context-specific default value should be used.
+
+[[NNG_DURATION_INFINITE]]((`NNG_DURATION_INFINITE`)):::
+Effectively an infinite duration; used most often to disable timeouts.
+
+[[NNG_DURATION_ZERO]]((`NNG_DURATION_ZERO`)):::
+Zero length duration; used to perform a single polling operation.
+
+== SEE ALSO
+[.text-left]
+<<nng_options#,nng_options(5)>>,
+<<nng#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2

