From 51bebe0c6f137d293dbb6f1194ad3f6fca5b79e9 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Tue, 6 Feb 2018 16:07:10 -0800
Subject: Document HTTP server API completely.

---
 docs/nng_http_handler_set_tree.adoc | 52 +++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 docs/nng_http_handler_set_tree.adoc

(limited to 'docs/nng_http_handler_set_tree.adoc')

diff --git a/docs/nng_http_handler_set_tree.adoc b/docs/nng_http_handler_set_tree.adoc
new file mode 100644
index 00000000..45b998bc
--- /dev/null
+++ b/docs/nng_http_handler_set_tree.adoc
@@ -0,0 +1,52 @@
+= nng_http_handler_set_tree(3)
+:doctype: manpage
+:manmanual: nng
+:mansource: nng
+:manvolnum: 3
+:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
+            Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
+            {blank} + \
+            This document is supplied under the terms of the \
+            https://opensource.org/licenses/MIT[MIT License].
+
+== NAME
+
+nng_http_handler_set_tree - set HTTP handler to match trees
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+int nng_http_handler_set_tree(nng_http_handler *handler);
+-----------
+
+== DESCRIPTION
+
+The `nng_http_handler_set_tree()` function causes the _handler_ to be
+matched if the Request URI sent by the client is a logical child of
+the path for _handler_.
+
+TIP: This method is useful when constructing API handlers where a single
+service address (path) supports dynamically generated children.
+
+== RETURN VALUES
+
+This function returns 0 on success, and non-zero otherwise.
+
+== ERRORS
+
+`NNG_ENOMEM`:: Insufficient free memory exists.
+`NNG_ENOTSUP`:: No support for HTTP in the library.
+
+== SEE ALSO
+
+<<nng_http_handler_alloc#,nng_http_handler_alloc(3)>>,
+<<nng_http_server_add_handler#,nng_http_server_add_handler(3)>>,
+<<nng_http_req_get_method#,nng_http_req_get_method(3)>>,
+<<nng#,nng(7)>>
+
+== COPYRIGHT
+
+{copyright}
-- 
cgit v1.2.3-70-g09d2

