From c33c5fc5191bbfe794eac5c3548171c628458495 Mon Sep 17 00:00:00 2001 From: Fred Eisele Date: Thu, 9 Aug 2018 13:51:26 -0500 Subject: updates to the documentation --- docs/man/libnng.3.adoc | 14 +++++++------- docs/man/nng_cv_until.3supp.adoc | 4 ++-- docs/man/nng_http_handler_get_data.3http.adoc | 3 +-- docs/man/nng_http_handler_set_data.3http.adoc | 4 ++-- docs/man/nng_http_req_del_header.3http.adoc | 4 ++-- docs/man/nng_http_req_get_uri.3http.adoc | 2 +- docs/man/nng_http_server_res_error.3http.adoc | 2 +- docs/man/nng_tls_config_ca_chain.3tls.adoc | 3 +-- 8 files changed, 17 insertions(+), 19 deletions(-) (limited to 'docs/man') diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc index 70fd3be2..ec88cdd0 100644 --- a/docs/man/libnng.3.adoc +++ b/docs/man/libnng.3.adoc @@ -245,7 +245,7 @@ as a convenience to aid in creating portable applications. |<>|wait for condition or timeout |<>|wait for condition |<>|wake all waiters -|<>|wake one waiter +|<>|wake one waiter |<>|sleep for milliseconds |<>|allocate mutex |<>|free mutex @@ -275,11 +275,11 @@ and connections. |<>|read from HTTP connection |<>|read all from HTTP connection |<>|read HTTP request -|<>|read HTTP response +|<>|read HTTP response |<>|write to HTTP connection |<>|write all to HTTP connection -|<>|write HTTP request -|<>|write HTTP response +|<>|write HTTP request +|<>|write HTTP response |<>|add HTTP request header |<>|allocate HTTP request structure |<>|copy HTTP request body @@ -339,8 +339,8 @@ These functions are intended for use with HTTP server applications. |<>|add HTTP server handler |<>|delete HTTP server handler |<>|get HTTP server TLS configuration -|<>|get and hold HTTP server instance -|<>|release HTTP server instance +|<>|get and hold HTTP server instance +|<>|release HTTP server instance |<>|set custom HTTP error file |<>|set custom HTTP error page |<>|set HTTP server TLS configuration @@ -362,7 +362,7 @@ with TLS support. |<>|set authentication mode |<>|set certificate authority chain |<>|load certificate authority from file -|<>|load own certificate and key from file +|<>|load own certificate and key from file |<>|set own certificate and key |<>|free TLS configuration |<>|set remote server name diff --git a/docs/man/nng_cv_until.3supp.adoc b/docs/man/nng_cv_until.3supp.adoc index 707b42b3..085d3c16 100644 --- a/docs/man/nng_cv_until.3supp.adoc +++ b/docs/man/nng_cv_until.3supp.adoc @@ -20,7 +20,7 @@ nng_cv_until - wait for condition or timeout #include #include -int nng_cv_wait(nng_cv *cv, nng_time when); +int nng_cv_until(nng_cv *cv, nng_time when); ---- == DESCRIPTION @@ -65,7 +65,7 @@ The following example demonstrates use of this function: ---- nng_mtx_lock(m); condition_true = true; - cv_wake(cv); + nng_cv_wake(cv); nng_mtx_unlock(m); ---- diff --git a/docs/man/nng_http_handler_get_data.3http.adoc b/docs/man/nng_http_handler_get_data.3http.adoc index b926fb2a..f7fcd6f5 100644 --- a/docs/man/nng_http_handler_get_data.3http.adoc +++ b/docs/man/nng_http_handler_get_data.3http.adoc @@ -20,8 +20,7 @@ nng_http_handler_get_data - return extra data for HTTP handler #include #include -int nng_http_handler_get_data(nng_http_handler *handler, void *data, - void (*dtor)(void *)); +void *nng_http_handler_get_data(nng_http_handler *handler); ---- == DESCRIPTION diff --git a/docs/man/nng_http_handler_set_data.3http.adoc b/docs/man/nng_http_handler_set_data.3http.adoc index 120c4618..9fd622b0 100644 --- a/docs/man/nng_http_handler_set_data.3http.adoc +++ b/docs/man/nng_http_handler_set_data.3http.adoc @@ -11,7 +11,7 @@ == NAME -nng_http_handler_get_data - set extra data for HTTP handler +nng_http_handler_set_data - set extra data for HTTP handler == SYNOPSIS @@ -20,7 +20,7 @@ nng_http_handler_get_data - set extra data for HTTP handler #include #include -void *nng_http_handler_get_data(nng_http_handler *handler, void *data, +int nng_http_handler_set_data(nng_http_handler *handler, void *data, void (*dtor)(void *)); ---- diff --git a/docs/man/nng_http_req_del_header.3http.adoc b/docs/man/nng_http_req_del_header.3http.adoc index 48a4326d..51f60fa8 100644 --- a/docs/man/nng_http_req_del_header.3http.adoc +++ b/docs/man/nng_http_req_del_header.3http.adoc @@ -11,7 +11,7 @@ == NAME -nng_http_req_set_header - set HTTP request header +nng_http_req_del_header - del HTTP request header == SYNOPSIS @@ -20,7 +20,7 @@ nng_http_req_set_header - set HTTP request header #include #include -int nng_http_req_set_header(nng_http_req *req, const char *key); +int nng_http_req_del_header(nng_http_req *req, const char *key); ---- == DESCRIPTION diff --git a/docs/man/nng_http_req_get_uri.3http.adoc b/docs/man/nng_http_req_get_uri.3http.adoc index 22ac1acb..d8b85aa2 100644 --- a/docs/man/nng_http_req_get_uri.3http.adoc +++ b/docs/man/nng_http_req_get_uri.3http.adoc @@ -20,7 +20,7 @@ nng_http_req_get_uri - return HTTP request URI #include #include -const char *nng_http_req_get_method(nng_http_req *req); +const char *nng_http_req_get_uri(nng_http_req *); ---- == DESCRIPTION diff --git a/docs/man/nng_http_server_res_error.3http.adoc b/docs/man/nng_http_server_res_error.3http.adoc index a62628f7..c1ab7f51 100644 --- a/docs/man/nng_http_server_res_error.3http.adoc +++ b/docs/man/nng_http_server_res_error.3http.adoc @@ -20,7 +20,7 @@ nng_http_server_res_error - use HTTP server error page #include #include -int nng_http_server_set_error_file(nng_http_server *server, +int nng_http_server_res_error(nng_http_server *server, nng_http_res *response); ---- diff --git a/docs/man/nng_tls_config_ca_chain.3tls.adoc b/docs/man/nng_tls_config_ca_chain.3tls.adoc index 65468d41..52e2c1c3 100644 --- a/docs/man/nng_tls_config_ca_chain.3tls.adoc +++ b/docs/man/nng_tls_config_ca_chain.3tls.adoc @@ -20,8 +20,7 @@ nng_tls_config_ca_chain - configure certificate authority certificate chain #include #include -int nng_tls_config_ca_cert(nng_tls_config *cfg, const char *chain, - const char *crl); +int nng_tls_config_ca_chain(nng_tls_config *cfg, const char *chain, const char *crl); ---- == DESCRIPTION -- cgit v1.2.3-70-g09d2