diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-29 17:03:51 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-29 18:14:55 -0700 |
| commit | 0ddaee41ec753805fa12eeabd679870802528dac (patch) | |
| tree | 3418859f4f22e9857b5ae979b3bc4eb53fd70035 /docs/man/nng_tls_config_alloc.3tls.adoc | |
| parent | 33dc5d611f578ace9833a80dc006a34b09da18af (diff) | |
| download | nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.gz nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.bz2 nng-0ddaee41ec753805fa12eeabd679870802528dac.zip | |
fixes #495 SEE ALSO should use [align=left]
fixes #494 ERRORS section should use [horizontal]
These changes address some basic formatting consistency things,
and ultimately (when combined with other tooling changes that are
not part of this repo) lead to vastly improved layout in the
printed documentation.
While here we removed trailing whitespace, and did certain other
minor markup tweaks.
Diffstat (limited to 'docs/man/nng_tls_config_alloc.3tls.adoc')
| -rw-r--r-- | docs/man/nng_tls_config_alloc.3tls.adoc | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/man/nng_tls_config_alloc.3tls.adoc b/docs/man/nng_tls_config_alloc.3tls.adoc index 38d068ee..3c898383 100644 --- a/docs/man/nng_tls_config_alloc.3tls.adoc +++ b/docs/man/nng_tls_config_alloc.3tls.adoc @@ -16,17 +16,17 @@ nng_tls_config_alloc - allocate TLS configuration object == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/tls/tls.h> typedef enum nng_tls_mode { - NNG_TLS_MODE_CLIENT, - NNG_TLS_MODE_SERVER + NNG_TLS_MODE_CLIENT, + NNG_TLS_MODE_SERVER } nng_tls_mode; int nng_tls_config_alloc(nni_tls_config **cfgp, nng_tls_mode mode); ------------ +---- == DESCRIPTION @@ -59,11 +59,13 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EINVAL`:: An invalid _mode_ was specified. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_tls_config_auth_mode.3tls#,nng_tls_config_auth_mode(3tls)>>, <<nng_tls_config_ca_chain.3tls#,nng_tls_config_ca_chain(3tls)>>, |