From 513dd92d08733449ae8da766d0ec6e89f1478e22 Mon Sep 17 00:00:00 2001 From: Filip Date: Fri, 8 Mar 2024 19:57:37 -0500 Subject: [PATCH 1/3] Rephrase some definitions in the docs for a better understanding --- pjnath/include/pjnath/turn_sock.h | 4 ++-- pjsip/include/pjsua-lib/pjsua.h | 13 ++++++------- pjsip/include/pjsua2/siptypes.hpp | 5 ++--- 3 files changed, 10 insertions(+), 12 deletions(-) diff --git a/pjnath/include/pjnath/turn_sock.h b/pjnath/include/pjnath/turn_sock.h index 46f39e4eb9..15386002a9 100644 --- a/pjnath/include/pjnath/turn_sock.h +++ b/pjnath/include/pjnath/turn_sock.h @@ -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 used when connecting to the TURN server. */ pj_turn_sock_tls_cfg tls_cfg; diff --git a/pjsip/include/pjsua-lib/pjsua.h b/pjsip/include/pjsua-lib/pjsua.h index d241822e5d..51b0609914 100644 --- a/pjsip/include/pjsua-lib/pjsua.h +++ b/pjsip/include/pjsua-lib/pjsua.h @@ -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. + * It’s 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. + * It’s only used when connecting 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. + * It’s only used when connecting to the TURN server. */ pj_turn_sock_tls_cfg turn_tls_setting; diff --git a/pjsip/include/pjsua2/siptypes.hpp b/pjsip/include/pjsua2/siptypes.hpp index 7b7c079a46..3ad30007f0 100644 --- a/pjsip/include/pjsua2/siptypes.hpp +++ b/pjsip/include/pjsua2/siptypes.hpp @@ -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. + * It’s only used when creating a SIP TLS transport. */ TlsConfig tlsConfig; From 6bd7412437e6e58f0b03428217e147ddd1d8e897 Mon Sep 17 00:00:00 2001 From: sauwming Date: Tue, 12 Mar 2024 10:13:29 +0800 Subject: [PATCH 2/3] Update pjsua.h-modify the doc --- pjsip/include/pjsua-lib/pjsua.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pjsip/include/pjsua-lib/pjsua.h b/pjsip/include/pjsua-lib/pjsua.h index 51b0609914..e8d91d11e6 100644 --- a/pjsip/include/pjsua-lib/pjsua.h +++ b/pjsip/include/pjsua-lib/pjsua.h @@ -3795,8 +3795,8 @@ typedef struct pjsua_turn_config pj_stun_auth_cred turn_auth_cred; /** - * This specifies TLS settings for TURN TLS. - * It’s only used when connecting to the TURN server. + * This specifies TLS settings for TURN TLS. It’s only applicable when + * TLS is used to connect to the TURN server. */ pj_turn_sock_tls_cfg turn_tls_setting; @@ -7393,8 +7393,8 @@ struct pjsua_media_config pj_stun_auth_cred turn_auth_cred; /** - * This specifies TLS settings for TLS transport. - * It’s only used when connecting 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 turn_tls_setting; From 7aa1962e545f8a15a43fec1a96b7e2fa706f09a4 Mon Sep 17 00:00:00 2001 From: sauwming Date: Tue, 12 Mar 2024 10:15:40 +0800 Subject: [PATCH 3/3] Update turn_sock.h - modify doc --- pjnath/include/pjnath/turn_sock.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pjnath/include/pjnath/turn_sock.h b/pjnath/include/pjnath/turn_sock.h index 15386002a9..3169c2c538 100644 --- a/pjnath/include/pjnath/turn_sock.h +++ b/pjnath/include/pjnath/turn_sock.h @@ -355,8 +355,8 @@ typedef struct pj_turn_sock_cfg unsigned so_sndbuf_size; /** - * This specifies TLS settings for TLS transport. - * It’s only used when connecting 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;