diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-06-22 01:04:47 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-06-27 22:30:19 +0200 |
| commit | f7f6115f7627df24a08a9a0882b2f573cc838eb1 (patch) | |
| tree | 03fd75145084c88702dbbb7e54c42c7c02d54fa6 /modules/webrtc/doc_classes | |
| parent | 538c8eec15d72b67e102f47f9df7624c29d14607 (diff) | |
Proofread and improve the whole class reference
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
Diffstat (limited to 'modules/webrtc/doc_classes')
| -rw-r--r-- | modules/webrtc/doc_classes/WebRTCPeerConnection.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml index 4c2938d0db..26082d73a8 100644 --- a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml +++ b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml @@ -60,7 +60,7 @@ "protocol": "my-custom-protocol", # A custom sub-protocol string for this channel. } [/codeblock] - NOTE: You must keep a reference to channels created this way, or it will be closed. + [b]Note:[/b] You must keep a reference to channels created this way, or it will be closed. </description> </method> <method name="create_offer"> @@ -172,7 +172,7 @@ The connection is new, data channels and an offer can be created in this state. </constant> <constant name="STATE_CONNECTING" value="1" enum="ConnectionState"> - The peer is connecting, ICE is in progress, non of the transports has failed. + The peer is connecting, ICE is in progress, none of the transports has failed. </constant> <constant name="STATE_CONNECTED" value="2" enum="ConnectionState"> The peer is connected, all ICE transports are connected. |