Skip to content

Commit c63258d

Browse files
author
Seppo Takalo
committed
Include TLSSocket and DTLSSocket in Doxygen
1 parent bdc355f commit c63258d

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

features/netsocket/DTLSSocket.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
#include "UDPSocket.h"
2424

2525
// This class requires Mbed TLS SSL/TLS client code
26-
#if defined(MBEDTLS_SSL_CLI_C)
26+
#if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
2727

2828
class DTLSSocket : public DTLSSocketWrapper {
2929
public:

features/netsocket/DTLSSocketWrapper.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#include "TLSSocketWrapper.h"
55

66
// This class requires Mbed TLS SSL/TLS client code
7-
#if defined(MBEDTLS_SSL_CLI_C)
7+
#if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
88

99
class DTLSSocketWrapper : public TLSSocketWrapper {
1010
public:

features/netsocket/TLSSocket.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
#include "mbedtls/error.h"
2929

3030
// This class requires Mbed TLS SSL/TLS client code
31-
#if defined(MBEDTLS_SSL_CLI_C)
31+
#if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
3232

3333
/**
3434
* \brief TLSSocket a wrapper around TCPSocket for interacting with TLS servers

features/netsocket/TLSSocketWrapper.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
#include "mbedtls/error.h"
2929

3030
// This class requires Mbed TLS SSL/TLS client code
31-
#if defined(MBEDTLS_SSL_CLI_C)
31+
#if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
3232

3333
/**
3434
* \brief TLSSocket a wrapper around Socket for interacting with TLS servers
@@ -135,7 +135,7 @@ class TLSSocketWrapper : public Socket {
135135
virtual nsapi_error_t listen(int backlog = 1);
136136
virtual nsapi_error_t getpeername(SocketAddress *address);
137137

138-
#if defined(MBEDTLS_X509_CRT_PARSE_C) || defined(DOXYGEN)
138+
#if defined(MBEDTLS_X509_CRT_PARSE_C) || defined(DOXYGEN_ONLY)
139139
/** Get own certificate directly from Mbed TLS
140140
* @return internal Mbed TLS X509 structure
141141
*/

0 commit comments

Comments
 (0)