diff options
author | dartraiden <wowemuh@gmail.com> | 2017-08-22 21:49:48 +0300 |
---|---|---|
committer | Robin Lindén <dev@robinlinden.eu> | 2017-09-20 21:31:56 +0200 |
commit | 987ad5eac173442d6ad2d5cd80c2da763a815a9a (patch) | |
tree | 4a0c344d78f24c0fb0218557fd6c8b85fe4541ee /docs | |
parent | 9e43d678fb7e42526aa5ee2429efee4776dad69f (diff) |
Fix typos in docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/TCP_Network.txt | 2 | ||||
-rw-r--r-- | docs/av_api.md | 8 | ||||
-rw-r--r-- | docs/updates/Crypto.md | 2 |
3 files changed, 6 insertions, 6 deletions
diff --git a/docs/TCP_Network.txt b/docs/TCP_Network.txt index 4bc2d433..aa2fd46f 100644 --- a/docs/TCP_Network.txt +++ b/docs/TCP_Network.txt | |||
@@ -23,7 +23,7 @@ public key. | |||
23 | 23 | ||
24 | 4. Bob receives an onion packet from Alice telling him which nodes she is | 24 | 4. Bob receives an onion packet from Alice telling him which nodes she is |
25 | connected to. Bob connects to these nodes and establishes a routed connection | 25 | connected to. Bob connects to these nodes and establishes a routed connection |
26 | with alice using that temporary public key. | 26 | with Alice using that temporary public key. |
27 | 27 | ||
28 | 5. That connection is used by both to transmit encrypted Messenger and A/V | 28 | 5. That connection is used by both to transmit encrypted Messenger and A/V |
29 | packets. | 29 | packets. |
diff --git a/docs/av_api.md b/docs/av_api.md index f94b0c5d..a087cdad 100644 --- a/docs/av_api.md +++ b/docs/av_api.md | |||
@@ -10,7 +10,7 @@ phone_t* initPhone(uint16_t _listen_port, uint16_t _send_port); | |||
10 | 10 | ||
11 | function initializes sample phone. _listen_port and _send_port are variables only meant | 11 | function initializes sample phone. _listen_port and _send_port are variables only meant |
12 | for local testing. You will not have to do anything regarding to that since | 12 | for local testing. You will not have to do anything regarding to that since |
13 | everything will be started within a mesenger. | 13 | everything will be started within a messenger. |
14 | 14 | ||
15 | 15 | ||
16 | Phone requires one msi session and two rtp sessions ( one for audio and one for | 16 | Phone requires one msi session and two rtp sessions ( one for audio and one for |
@@ -78,7 +78,7 @@ Hangs up active call | |||
78 | ``` | 78 | ``` |
79 | int msi_answer ( msi_session_t* _session, call_type _call_type ); | 79 | int msi_answer ( msi_session_t* _session, call_type _call_type ); |
80 | ``` | 80 | ``` |
81 | Answer incomming call. _call_type set's callee call type. | 81 | Answer incoming call. _call_type set's callee call type. |
82 | 82 | ||
83 | ``` | 83 | ``` |
84 | int msi_cancel ( msi_session_t* _session ); | 84 | int msi_cancel ( msi_session_t* _session ); |
@@ -88,7 +88,7 @@ Cancel current request. | |||
88 | ``` | 88 | ``` |
89 | int msi_reject ( msi_session_t* _session ); | 89 | int msi_reject ( msi_session_t* _session ); |
90 | ``` | 90 | ``` |
91 | Reject incomming call. | 91 | Reject incoming call. |
92 | 92 | ||
93 | 93 | ||
94 | ### Now for rtp: | 94 | ### Now for rtp: |
@@ -169,7 +169,7 @@ void *encode_audio_thread(void *arg); | |||
169 | ``` | 169 | ``` |
170 | Spawns the audio encoding thread. The argument should hold a pointer to a codec_state. | 170 | Spawns the audio encoding thread. The argument should hold a pointer to a codec_state. |
171 | This function should only be called if audio encoding is supported (when init_send_audio returns 1). | 171 | This function should only be called if audio encoding is supported (when init_send_audio returns 1). |
172 | Audio frames are read from the selected audio capture device during intitialisation. This audio capturing can be rerouted to a different device on the fly. | 172 | Audio frames are read from the selected audio capture device during initialisation. This audio capturing can be rerouted to a different device on the fly. |
173 | Each audio frame is encoded into a packet, and sent via RTP. All audio frames have the same amount of samples, which is defined in AV_codec.h. | 173 | Each audio frame is encoded into a packet, and sent via RTP. All audio frames have the same amount of samples, which is defined in AV_codec.h. |
174 | ``` | 174 | ``` |
175 | int video_decoder_refresh(codec_state *cs, int width, int height); | 175 | int video_decoder_refresh(codec_state *cs, int width, int height); |
diff --git a/docs/updates/Crypto.md b/docs/updates/Crypto.md index bfb01034..fd169a2e 100644 --- a/docs/updates/Crypto.md +++ b/docs/updates/Crypto.md | |||
@@ -46,7 +46,7 @@ Crypto request packets | |||
46 | -------------------------------------- | 46 | -------------------------------------- |
47 | 47 | ||
48 | ``` | 48 | ``` |
49 | [char with a value of 32][Bob (The reciever's) Public key (client_id) (32 bytes))][Alice's (The sender's) Public key (client_id) (32 bytes)][Random nonce (24 bytes)][Encrypted message] | 49 | [char with a value of 32][Bob (The receiver's) Public key (client_id) (32 bytes))][Alice's (The sender's) Public key (client_id) (32 bytes)][Random nonce (24 bytes)][Encrypted message] |
50 | ``` | 50 | ``` |
51 | 51 | ||
52 | The encrypted message is encrypted with crypto_box() (using Bob's public key, Alice's private key and the nonce (randomly generated 24 bytes)) and is a message from Alice in which she tells Bob who she is. | 52 | The encrypted message is encrypted with crypto_box() (using Bob's public key, Alice's private key and the nonce (randomly generated 24 bytes)) and is a message from Alice in which she tells Bob who she is. |