Fix typos, grammar in the comments and clarify them

This commit is contained in:
Simon Butcher 2016-03-09 20:19:21 +00:00
parent 00157ce510
commit d567a23c59
2 changed files with 9 additions and 9 deletions

View File

@ -1899,8 +1899,8 @@
* *
* Enable the TCP and UDP over IPv6/IPv4 networking routines. * Enable the TCP and UDP over IPv6/IPv4 networking routines.
* *
* \note This module only works on Unix (including Linux, BSD and OS X) and * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
* Windows. For other platforms, you'll want to disable it, and write your * and Windows. For other platforms, you'll want to disable it, and write your
* own networking callbacks to be passed to \c mbedtls_ssl_set_bio(). * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
* *
* \note See also our Knowledge Base article about porting to a new * \note See also our Knowledge Base article about porting to a new
@ -2275,8 +2275,8 @@
* *
* Enable the semi-portable timing interface. * Enable the semi-portable timing interface.
* *
* \note The provided implementation only works on Unix (including Linux, BSD * \note The provided implementation only works on POSIX/Unix (including Linux,
* and OS X) and Windows. On other platforms, you can either disable that * BSD and OS X) and Windows. On other platforms, you can either disable that
* module and provide your own implementations of the callbacks needed by * module and provide your own implementations of the callbacks needed by
* \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
* your own implementation of the whole module by setting * your own implementation of the whole module by setting

View File

@ -417,7 +417,7 @@ mbedtls_ssl_states;
* \note That callback may be either blocking or non-blocking. * \note That callback may be either blocking or non-blocking.
* *
* \param ctx Context for the send callback (typically a file descriptor) * \param ctx Context for the send callback (typically a file descriptor)
* \param buf Buffer holding the date to send * \param buf Buffer holding the data to send
* \param len Length of the data to send * \param len Length of the data to send
* *
* \return The callback must return the number of bytes sent if any, * \return The callback must return the number of bytes sent if any,
@ -425,7 +425,7 @@ mbedtls_ssl_states;
* If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
* must be returned when the operation would block. * must be returned when the operation would block.
* *
* \note The callback is allowed to send less bytes than requested. * \note The callback is allowed to send fewer bytes than requested.
* It must always return the number of bytes actually sent. * It must always return the number of bytes actually sent.
*/ */
typedef int mbedtls_ssl_send_t( void *ctx, typedef int mbedtls_ssl_send_t( void *ctx,
@ -447,7 +447,7 @@ typedef int mbedtls_ssl_send_t( void *ctx,
* If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
* must be returned when the operation would block. * must be returned when the operation would block.
* *
* \note The callback may receive less bytes than the length of the * \note The callback may receive fewer bytes than the length of the
* buffer. It must always return the number of bytes actually * buffer. It must always return the number of bytes actually
* received and written to the buffer. * received and written to the buffer.
*/ */
@ -473,7 +473,7 @@ typedef int mbedtls_ssl_recv_t( void *ctx,
* \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out, * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
* \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal. * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
* *
* \note The callback may receive less bytes than the length of the * \note The callback may receive fewer bytes than the length of the
* buffer. It must always return the number of bytes actually * buffer. It must always return the number of bytes actually
* received and written to the buffer. * received and written to the buffer.
*/ */
@ -1102,7 +1102,7 @@ void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
* *
* \note See the documentations of \c mbedtls_ssl_sent_t, * \note See the documentations of \c mbedtls_ssl_sent_t,
* \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
* the convetions those callbacks must follow. * the conventions those callbacks must follow.
* *
* \note On some platforms, net.c provides \c mbedtls_net_send(), * \note On some platforms, net.c provides \c mbedtls_net_send(),
* \c mbedtls_net_recv() and \c mbedtls_net_recv_timeout() * \c mbedtls_net_recv() and \c mbedtls_net_recv_timeout()