Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Mar 12, 2024
+10 −12
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
513dd92
Rephrase some definitions in the docs for a better understanding
filNaj Mar 9, 2024
6bd7412
Update pjsua.h-modify the doc
sauwming Mar 12, 2024
7aa1962
Update turn_sock.h - modify doc
sauwming Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pjnath/include/pjnath/turn_sock.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
13 changes: 6 additions & 7 deletions pjsip/include/pjsua-lib/pjsua.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down Expand Up @@ -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 applicable when
* TLS is used to connect to the TURN server.
*/
pj_turn_sock_tls_cfg turn_tls_setting;

Expand Down Expand Up @@ -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 applicable
* when TLS is used to connect to the TURN server.
*/
pj_turn_sock_tls_cfg turn_tls_setting;

Expand Down
5 changes: 2 additions & 3 deletions pjsip/include/pjsua2/siptypes.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
Loading