Fix swapped documentation of set_user_data_{n,p}

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2022-01-27 23:30:52 +01:00
parent 49d7ddf7f3
commit 1e265d2e68

View File

@ -2338,10 +2338,10 @@ static inline void mbedtls_ssl_conf_set_user_data_n(
/** \brief Retrieve the user data in an SSL configuration as a pointer. /** \brief Retrieve the user data in an SSL configuration as a pointer.
* *
* This is the value last set with mbedtls_ssl_conf_set_user_data_n(), or * This is the value last set with mbedtls_ssl_conf_set_user_data_p(), or
* \c 0 if mbedtls_ssl_conf_set_user_data_n() has not previously been * \c NULL if mbedtls_ssl_conf_set_user_data_p() has not previously been
* called. The value is undefined if mbedtls_ssl_conf_set_user_data_p() has * called. The value is undefined if mbedtls_ssl_conf_set_user_data_n() has
* been called without a subsequent call to mbedtls_ssl_conf_set_user_data_n(). * been called without a subsequent call to mbedtls_ssl_conf_set_user_data_p().
* *
* \param conf The SSL configuration context to modify. * \param conf The SSL configuration context to modify.
* \return The current value of the user data. * \return The current value of the user data.
@ -2354,10 +2354,10 @@ static inline void *mbedtls_ssl_conf_get_user_data_p(
/** \brief Retrieve the user data in an SSL configuration as an integer. /** \brief Retrieve the user data in an SSL configuration as an integer.
* *
* This is the value last set with mbedtls_ssl_conf_set_user_data_p(), or * This is the value last set with mbedtls_ssl_conf_set_user_data_n(), or
* \c NULL if mbedtls_ssl_conf_set_user_data_p() has not previously been * \c 0 if mbedtls_ssl_conf_set_user_data_n() has not previously been
* called. The value is undefined if mbedtls_ssl_conf_set_user_data_n() has * called. The value is undefined if mbedtls_ssl_conf_set_user_data_p() has
* been called without a subsequent call to mbedtls_ssl_conf_set_user_data_p(). * been called without a subsequent call to mbedtls_ssl_conf_set_user_data_n().
* *
* \param conf The SSL configuration context to modify. * \param conf The SSL configuration context to modify.
* \return The current value of the user data. * \return The current value of the user data.
@ -2401,10 +2401,10 @@ static inline void mbedtls_ssl_set_user_data_n(
/** \brief Retrieve the user data in an SSL context as a pointer. /** \brief Retrieve the user data in an SSL context as a pointer.
* *
* This is the value last set with mbedtls_ssl_set_user_data_n(), or * This is the value last set with mbedtls_ssl_set_user_data_p(), or
* \c 0 if mbedtls_ssl_set_user_data_n() has not previously been * \c NULL if mbedtls_ssl_set_user_data_p() has not previously been
* called. The value is undefined if mbedtls_ssl_set_user_data_p() has * called. The value is undefined if mbedtls_ssl_set_user_data_n() has
* been called without a subsequent call to mbedtls_ssl_set_user_data_n(). * been called without a subsequent call to mbedtls_ssl_set_user_data_p().
* *
* \param ssl The SSL context context to modify. * \param ssl The SSL context context to modify.
* \return The current value of the user data. * \return The current value of the user data.
@ -2417,10 +2417,10 @@ static inline void *mbedtls_ssl_get_user_data_p(
/** \brief Retrieve the user data in an SSL context as an integer. /** \brief Retrieve the user data in an SSL context as an integer.
* *
* This is the value last set with mbedtls_ssl_set_user_data_p(), or * This is the value last set with mbedtls_ssl_set_user_data_n(), or
* \c NULL if mbedtls_ssl_set_user_data_p() has not previously been * \c 0 if mbedtls_ssl_set_user_data_n() has not previously been
* called. The value is undefined if mbedtls_ssl_set_user_data_n() has * called. The value is undefined if mbedtls_ssl_set_user_data_p() has
* been called without a subsequent call to mbedtls_ssl_set_user_data_p(). * been called without a subsequent call to mbedtls_ssl_set_user_data_n().
* *
* \param ssl The SSL context context to modify. * \param ssl The SSL context context to modify.
* \return The current value of the user data. * \return The current value of the user data.