From 03447b4532e12df48ab117c7433786334b8aeff7 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Wed, 7 Feb 2018 13:59:11 -0800
Subject: Add documentation for HTTP client API.

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

(limited to 'docs/nng_http_client_alloc.adoc')

diff --git a/docs/nng_http_client_alloc.adoc b/docs/nng_http_client_alloc.adoc
new file mode 100644
index 00000000..32b30ce5
--- /dev/null
+++ b/docs/nng_http_client_alloc.adoc
@@ -0,0 +1,51 @@
+= nng_http_client_alloc(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_client_alloc - allocate HTTP client
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+int nng_http_client_alloc(nng_http_client *clientp, const nng_url *url);
+-----------
+
+
+== DESCRIPTION
+
+The `nng_http_client_alloc()` allocates an HTTP client suitable for
+connecting to the server identifyed by _url_ and stores a pointer to
+it in the location referenced by _clientp_.
+
+== RETURN VALUES
+
+This function returns 0 on success, and non-zero otherwise.
+
+== ERRORS
+
+`NNG_ENOMEM`:: Insufficient free memory exists.
+`NNG_ENOTSUP`:: HTTP not supported.
+
+== SEE ALSO
+
+<<nng_http_client_connect#,nng_http_client_connect(3)>>,
+<<nng_http_client_free#,nng_http_client_free(3)>>,
+<<nng_url_parse#,nng_url_parse(3)>>
+<<nng_strerror#,nng_strerror(3)>>,
+<<nng#,nng(7)>>
+
+== COPYRIGHT
+
+{copyright}
-- 
cgit v1.2.3-70-g09d2

