Skip to content

Commit 0fbdb69

Browse files
KariHaapalehtoSeppo Takalo
authored andcommitted
Doxygen corrections to:
- DTLSSocket.h - TLSSocket.h - TLSSocketWrapper.h
1 parent bfd497f commit 0fbdb69

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed

features/netsocket/DTLSSocket.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file DTLSSocket.h DTLSSocket */
12
/*
23
* Copyright (c) 2018 ARM Limited
34
* SPDX-License-Identifier: Apache-2.0
@@ -14,6 +15,9 @@
1415
* See the License for the specific language governing permissions and
1516
* limitations under the License.
1617
*/
18+
/** @addtogroup netsocket
19+
* @{
20+
*/
1721

1822
#ifndef DTLSSOCKET_H
1923
#define DTLSSOCKET_H
@@ -92,3 +96,4 @@ class DTLSSocket : public DTLSSocketWrapper {
9296

9397
#endif
9498
#endif
99+
/** @} */

features/netsocket/TLSSocket.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file TLSSocket.h TLSSocket */
12
/*
23
* Copyright (c) 2018 ARM Limited
34
* SPDX-License-Identifier: Apache-2.0
@@ -14,6 +15,9 @@
1415
* See the License for the specific language governing permissions and
1516
* limitations under the License.
1617
*/
18+
/** @addtogroup netsocket
19+
* @{
20+
*/
1721

1822
#ifndef _MBED_HTTPS_TLS_TCP_SOCKET_H_
1923
#define _MBED_HTTPS_TLS_TCP_SOCKET_H_
@@ -87,3 +91,5 @@ class TLSSocket : public TLSSocketWrapper {
8791

8892
#endif // MBEDTLS_SSL_CLI_C
8993
#endif // _MBED_HTTPS_TLS_TCP_SOCKET_H_
94+
95+
/** @} */

features/netsocket/TLSSocketWrapper.h

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** @file TLSSocketWrapper.h TLSSocketWrapper */
12
/*
23
* Copyright (c) 2018 ARM Limited
34
* SPDX-License-Identifier: Apache-2.0
@@ -14,6 +15,9 @@
1415
* See the License for the specific language governing permissions and
1516
* limitations under the License.
1617
*/
18+
/** @addtogroup netsocket
19+
* @{
20+
*/
1721

1822
#ifndef _MBED_HTTPS_TLS_SOCKET_WRAPPER_H_
1923
#define _MBED_HTTPS_TLS_SOCKET_WRAPPER_H_
@@ -186,8 +190,8 @@ class TLSSocketWrapper : public Socket {
186190
* was a first call to Socket::connect() API so that NSAPI_ERROR_INPROGRESS
187191
* does not happen twice.
188192
*
189-
* @parameter first_call is this a first call to Socket::connect() API.
190-
* @return 0 on success, negative error code on failure
193+
* @param first_call is this a first call to Socket::connect() API.
194+
* @return 0 on success, negative error code on failure
191195
*/
192196
nsapi_error_t start_handshake(bool first_call);
193197

@@ -261,3 +265,4 @@ class TLSSocketWrapper : public Socket {
261265

262266
#endif /* MBEDTLS_SSL_CLI_C */
263267
#endif // _MBED_HTTPS_TLS_SOCKET_WRAPPER_H_
268+
/** @} */

0 commit comments

Comments
 (0)