[qpid-proton] branch master updated: NO-JIRA: Some small fixes to proton-c documentation

[as...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

astitcher pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/qpid-proton.git


The following commit(s) were added to refs/heads/master by this push:
     new e68b2d8  NO-JIRA: Some small fixes to proton-c documentation
e68b2d8 is described below

commit e68b2d8d1a022d0099c83e70a0d385f567bbaf8b
Author: Andrew Stitcher <as...@apache.org>
AuthorDate: Wed Jul 8 20:23:48 2020 -0400

    NO-JIRA: Some small fixes to proton-c documentation
---
 c/include/proton/logger.h  | 6 ++++--
 c/include/proton/message.h | 4 ++--
 c/include/proton/ssl.h     | 2 +-
 3 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/c/include/proton/logger.h b/c/include/proton/logger.h
index 8dfc74c..cfc6706 100644
--- a/c/include/proton/logger.h
+++ b/c/include/proton/logger.h
@@ -190,7 +190,7 @@ PN_EXTERN void pn_logger_set_mask(pn_logger_t *logger, uint16_t subsystem, uint1
  * @param[in] subsystem bits representing subsystems to turn off trace for
  * @param[in] level bits representing log levels to turn off trace for
  */
-PN_EXTERN void pn_logger_reset_mask(pn_logger_t *logger, uint16_t subsystem, uint16_t severity);
+PN_EXTERN void pn_logger_reset_mask(pn_logger_t *logger, uint16_t subsystem, uint16_t level);
 
 /**
  * Set the tracing function used by a logger.
@@ -228,9 +228,11 @@ PN_EXTERN intptr_t pn_logger_get_log_sink_context(pn_logger_t *logger);
  * be processed the same way.
  *
  * @param[in] logger the logger
+ * @param[in] subsystem the subsystem which is producing this log message
+ * @param[in] level the log level of the log message
  * @param[in] fmt the printf formatted message to be logged
  */
-PN_EXTERN void pn_logger_logf(pn_logger_t *logger, pn_log_subsystem_t subsystem, pn_log_level_t severity, const char *fmt, ...);
+PN_EXTERN void pn_logger_logf(pn_logger_t *logger, pn_log_subsystem_t subsystem, pn_log_level_t level, const char *fmt, ...);
 
 #ifdef __cplusplus
 }
diff --git a/c/include/proton/message.h b/c/include/proton/message.h
index 41c37af..80b9e00 100644
--- a/c/include/proton/message.h
+++ b/c/include/proton/message.h
@@ -731,8 +731,8 @@ PN_EXTERN int pn_message_decode(pn_message_t *msg, const char *bytes, size_t siz
  *
  * @param[in] msg a message object
  * @param[in] bytes the start of empty buffer space
- * @param[in] size the amount of empty buffer space
- * @param[out] size the amount of data written
+ * @param[inout] size the amount of empty buffer space.
+ *   On return size holds the amount of data written
  * @return zero on success or an error code on failure
  */
 PN_EXTERN int pn_message_encode(pn_message_t *msg, char *bytes, size_t *size);
diff --git a/c/include/proton/ssl.h b/c/include/proton/ssl.h
index 91d882e..03acbf5 100644
--- a/c/include/proton/ssl.h
+++ b/c/include/proton/ssl.h
@@ -259,7 +259,7 @@ PN_EXTERN int pn_ssl_domain_set_protocols(pn_ssl_domain_t *domain, const char *p
 PN_EXTERN int pn_ssl_domain_set_ciphers(pn_ssl_domain_t *domain, const char *ciphers);
 
 /**
- * **Deprecated** - Use ::pn_transport_require_encrytion()
+ * **Deprecated** - Use ::pn_transport_require_encryption()
  *
  * Permit a server to accept connection requests from non-SSL clients.
  *


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org