Rephrase some type definitions in the docs for a better understanding (#3880)

This commit is contained in:
Fil 2024-03-11 22:28:42 -04:00 committed by GitHub
parent c36802585d
commit 70332e3510
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 10 additions and 12 deletions

View File

@ -355,8 +355,8 @@ typedef struct pj_turn_sock_cfg
unsigned so_sndbuf_size;
/**
* This specifies TLS settings for TLS transport. It is only be used
* when this TLS is used to connect to the TURN server.
* This specifies TLS settings for TLS transport. It's only applicable when
* TLS is used to connect to the TURN server.
*/
pj_turn_sock_tls_cfg tls_cfg;

View File

@ -3205,9 +3205,8 @@ typedef struct pjsua_transport_config
pj_str_t bound_addr;
/**
* This specifies TLS settings for TLS transport. It is only be used
* when this transport config is being used to create a SIP TLS
* transport.
* This specifies TLS settings for TLS transport.
* Its only used when creating a SIP TLS transport.
*/
pjsip_tls_setting tls_setting;
@ -3796,8 +3795,8 @@ typedef struct pjsua_turn_config
pj_stun_auth_cred turn_auth_cred;
/**
* This specifies TLS settings for TURN TLS. It is only be used
* when this TLS is used to connect to the TURN server.
* This specifies TLS settings for TURN TLS. Its only applicable when
* TLS is used to connect to the TURN server.
*/
pj_turn_sock_tls_cfg turn_tls_setting;
@ -7394,8 +7393,8 @@ struct pjsua_media_config
pj_stun_auth_cred turn_auth_cred;
/**
* This specifies TLS settings for TLS transport. It is only be used
* when this TLS is used to connect to the TURN server.
* This specifies TLS settings for TLS transport. Its only applicable
* when TLS is used to connect to the TURN server.
*/
pj_turn_sock_tls_cfg turn_tls_setting;

View File

@ -376,9 +376,8 @@ struct TransportConfig : public PersistentObject
string boundAddress;
/**
* This specifies TLS settings for TLS transport. It is only be used
* when this transport config is being used to create a SIP TLS
* transport.
* This specifies TLS settings for TLS transport.
* Its only used when creating a SIP TLS transport.
*/
TlsConfig tlsConfig;