ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Include TLSSocket and DTLSSocket in Doxygen

pull/8659/head
Seppo Takalo 2018-11-19 17:52:13 +02:00
parent bdc355f873
commit 0f5cec3ebc
4 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
features/netsocket/DTLSSocket.h
View File

@ -23,7 +23,7 @@
#include "UDPSocket.h" #include "UDPSocket.h"
// This class requires Mbed TLS SSL/TLS client code // This class requires Mbed TLS SSL/TLS client code
#if defined(MBEDTLS_SSL_CLI_C) #if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
class DTLSSocket : public DTLSSocketWrapper { class DTLSSocket : public DTLSSocketWrapper {
public: public:

2
features/netsocket/DTLSSocketWrapper.h
View File

@ -4,7 +4,7 @@
#include "TLSSocketWrapper.h" #include "TLSSocketWrapper.h"
// This class requires Mbed TLS SSL/TLS client code // This class requires Mbed TLS SSL/TLS client code
#if defined(MBEDTLS_SSL_CLI_C) #if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
class DTLSSocketWrapper : public TLSSocketWrapper { class DTLSSocketWrapper : public TLSSocketWrapper {
public: public:

2
features/netsocket/TLSSocket.h
View File

@ -28,7 +28,7 @@
#include "mbedtls/error.h" #include "mbedtls/error.h"
// This class requires Mbed TLS SSL/TLS client code // This class requires Mbed TLS SSL/TLS client code
#if defined(MBEDTLS_SSL_CLI_C) #if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
/** /**
* \brief TLSSocket a wrapper around TCPSocket for interacting with TLS servers * \brief TLSSocket a wrapper around TCPSocket for interacting with TLS servers

4
features/netsocket/TLSSocketWrapper.h
View File

@ -28,7 +28,7 @@
#include "mbedtls/error.h" #include "mbedtls/error.h"
// This class requires Mbed TLS SSL/TLS client code // This class requires Mbed TLS SSL/TLS client code
#if defined(MBEDTLS_SSL_CLI_C) #if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
/** /**
* \brief TLSSocket a wrapper around Socket for interacting with TLS servers * \brief TLSSocket a wrapper around Socket for interacting with TLS servers
@ -135,7 +135,7 @@ public:
virtual nsapi_error_t listen(int backlog = 1); virtual nsapi_error_t listen(int backlog = 1);
virtual nsapi_error_t getpeername(SocketAddress *address); virtual nsapi_error_t getpeername(SocketAddress *address);
#if defined(MBEDTLS_X509_CRT_PARSE_C) || defined(DOXYGEN) #if defined(MBEDTLS_X509_CRT_PARSE_C) || defined(DOXYGEN_ONLY)
/** Get own certificate directly from Mbed TLS /** Get own certificate directly from Mbed TLS
* @return internal Mbed TLS X509 structure * @return internal Mbed TLS X509 structure
*/ */