fixes #1206 Document TLS engine support

1 files changed, 44 insertions, 0 deletions

diff --git a/docs/man/nng_tls_engine_description.3tls.adoc b/docs/man/nng_tls_engine_description.3tls.adoc
new file mode 100644
index 00000000..2b742d94
--- /dev/null
+++ b/docs/man/nng_tls_engine_description.3tls.adoc
@@ -0,0 +1,44 @@
+= nng_tls_engine_description(3tls)
+//
+// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech>
+//
+// 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_tls_engine_description - TLS engine description
+
+== SYNOPSIS
+
+[source,c]
+----
+#include <nng/supplemental/tls/tls.h>
+
+const char *nng_tls_engine_description(void);
+----
+
+== DESCRIPTION
+
+The `nng_tls_engine_description()` returns a short description for the current
+xref:tls_engine.5.adoc[TLS engine].
+If no engine is registered, then the empty string ("") is returned.
+This is principally useful for diagnostic purposes.
+
+== RETURN VALUES
+
+The description of the engine of the engine.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+[.text-left]
+xref:nng_tls_engine_name.3tls.adoc[nng_tls_engine_name(3tls)],
+xref:nng_tls_engine.5.adoc[nng_tls_engine(5)],
+xref:nng.7.adoc[nng(7)]