Unify documentation of internal SSL record structure

- Don't use Doxygen style comments
- Document CID and CID length fields.
This commit is contained in:
Hanno Becker 2019-05-20 14:49:02 +01:00
parent 505089d944
commit 346a590c1c

View file

@ -618,18 +618,18 @@ struct mbedtls_ssl_transform
typedef struct typedef struct
{ {
uint8_t ctr[8]; /*!< Record sequence number */ uint8_t ctr[8]; /* Record sequence number */
uint8_t type; /*!< Record type */ uint8_t type; /* Record type */
uint8_t ver[2]; /*!< SSL/TLS version */ uint8_t ver[2]; /* SSL/TLS version */
unsigned char *buf; /*!< Memory buffer enclosing the record content */ unsigned char *buf; /* Memory buffer enclosing the record content */
size_t buf_len; /*!< Buffer length */ size_t buf_len; /* Buffer length */
size_t data_offset; /*!< Offset of record content */ size_t data_offset; /* Offset of record content */
size_t data_len; /*!< Length of record content */ size_t data_len; /* Length of record content */
#if defined(MBEDTLS_SSL_CID) #if defined(MBEDTLS_SSL_CID)
uint8_t cid_len; uint8_t cid_len; /* Length of the CID (0 if not present) */
unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */
#endif /* MBEDTLS_SSL_CID */ #endif /* MBEDTLS_SSL_CID */
} mbedtls_record; } mbedtls_record;