PROTON-344: Fix header file documentation for new sasl API
Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/2f1a9899 Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/2f1a9899 Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/2f1a9899 Branch: refs/heads/kgiusti-python3 Commit: 2f1a98991fafe5ef7f1bbe09dc8d8ead2b1119b5 Parents: dcac9f1 Author: Andrew Stitcher <[email protected]> Authored: Fri Apr 24 13:42:41 2015 -0400 Committer: Andrew Stitcher <[email protected]> Committed: Fri Apr 24 13:43:35 2015 -0400 ---------------------------------------------------------------------- proton-c/include/proton/sasl.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/2f1a9899/proton-c/include/proton/sasl.h ---------------------------------------------------------------------- diff --git a/proton-c/include/proton/sasl.h b/proton-c/include/proton/sasl.h index d9600b4..f2d89a1 100644 --- a/proton-c/include/proton/sasl.h +++ b/proton-c/include/proton/sasl.h @@ -111,12 +111,13 @@ PN_EXTERN const char *pn_sasl_get_user(pn_sasl_t *sasl); */ PN_EXTERN const char *pn_sasl_get_mech(pn_sasl_t *sasl); -/** SASL mechanism that are not to be considered for authentication +/** SASL mechanisms that are to be considered for authentication * - * This can be used on either the client or the server to restrict the SASL mechanisms that may be used. + * This can be used on either the client or the server to restrict the SASL + * mechanisms that may be used to the mechanisms on the list. * * @param[in] sasl the SASL layer - * @param[in] mechs space separated list of mechanisms that are not to be allowed for authentication + * @param[in] mechs space separated list of mechanisms that are allowed for authentication */ PN_EXTERN void pn_sasl_allowed_mechs(pn_sasl_t *sasl, const char *mechs); --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
