Doxygen corrections to:

- DTLSSocket.h
- TLSSocket.h
- TLSSocketWrapper.h
pull/9328/head
Kari Haapalehto 2019-01-09 13:49:24 +02:00 committed by Seppo Takalo
parent bfd497fe26
commit 0fbdb692e9
3 changed files with 18 additions and 2 deletions

View File

@ -1,3 +1,4 @@
/** @file DTLSSocket.h DTLSSocket */
/* /*
* Copyright (c) 2018 ARM Limited * Copyright (c) 2018 ARM Limited
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -14,6 +15,9 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
/** @addtogroup netsocket
* @{
*/
#ifndef DTLSSOCKET_H #ifndef DTLSSOCKET_H
#define DTLSSOCKET_H #define DTLSSOCKET_H
@ -92,3 +96,4 @@ private:
#endif #endif
#endif #endif
/** @} */

View File

@ -1,3 +1,4 @@
/** @file TLSSocket.h TLSSocket */
/* /*
* Copyright (c) 2018 ARM Limited * Copyright (c) 2018 ARM Limited
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -14,6 +15,9 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
/** @addtogroup netsocket
* @{
*/
#ifndef _MBED_HTTPS_TLS_TCP_SOCKET_H_ #ifndef _MBED_HTTPS_TLS_TCP_SOCKET_H_
#define _MBED_HTTPS_TLS_TCP_SOCKET_H_ #define _MBED_HTTPS_TLS_TCP_SOCKET_H_
@ -87,3 +91,5 @@ private:
#endif // MBEDTLS_SSL_CLI_C #endif // MBEDTLS_SSL_CLI_C
#endif // _MBED_HTTPS_TLS_TCP_SOCKET_H_ #endif // _MBED_HTTPS_TLS_TCP_SOCKET_H_
/** @} */

View File

@ -1,3 +1,4 @@
/** @file TLSSocketWrapper.h TLSSocketWrapper */
/* /*
* Copyright (c) 2018 ARM Limited * Copyright (c) 2018 ARM Limited
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
@ -14,6 +15,9 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
/** @addtogroup netsocket
* @{
*/
#ifndef _MBED_HTTPS_TLS_SOCKET_WRAPPER_H_ #ifndef _MBED_HTTPS_TLS_SOCKET_WRAPPER_H_
#define _MBED_HTTPS_TLS_SOCKET_WRAPPER_H_ #define _MBED_HTTPS_TLS_SOCKET_WRAPPER_H_
@ -186,7 +190,7 @@ protected:
* was a first call to Socket::connect() API so that NSAPI_ERROR_INPROGRESS * was a first call to Socket::connect() API so that NSAPI_ERROR_INPROGRESS
* does not happen twice. * does not happen twice.
* *
* @parameter first_call is this a first call to Socket::connect() API. * @param first_call is this a first call to Socket::connect() API.
* @return 0 on success, negative error code on failure * @return 0 on success, negative error code on failure
*/ */
nsapi_error_t start_handshake(bool first_call); nsapi_error_t start_handshake(bool first_call);
@ -261,3 +265,4 @@ private:
#endif /* MBEDTLS_SSL_CLI_C */ #endif /* MBEDTLS_SSL_CLI_C */
#endif // _MBED_HTTPS_TLS_SOCKET_WRAPPER_H_ #endif // _MBED_HTTPS_TLS_SOCKET_WRAPPER_H_
/** @} */