Skip to content

Commit be085db

Browse files
committed
docs: Public headers, spellcheck
1 parent 4c90295 commit be085db

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

toxav/toxav.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
* ToxAV thread (see above). Audio and video receive frame events are triggered
4040
* from ToxAV thread while all the other events are triggered from Tox thread.
4141
*
42-
* Tox thread has priority with mutex mechanisms. Any api function can
42+
* Tox thread has priority with mutex mechanisms. Any API function can
4343
* fail if mutexes are held by Tox thread in which case they will set SYNC
4444
* error code.
4545
*
@@ -566,7 +566,7 @@ typedef enum Toxav_Err_Send_Frame {
566566
TOXAV_ERR_SEND_FRAME_PAYLOAD_TYPE_DISABLED,
567567

568568
/**
569-
* Failed to push frame through rtp interface.
569+
* Failed to push frame through RTP interface.
570570
*/
571571
TOXAV_ERR_SEND_FRAME_RTP_FAILED,
572572

@@ -588,7 +588,7 @@ typedef enum Toxav_Err_Send_Frame {
588588
* `sample_count * channels`.
589589
* @param sample_count Number of samples in this frame. Valid numbers here are
590590
* `((sample rate) * (audio length) / 1000)`, where audio length can be
591-
* 2.5, 5, 10, 20, 40 or 60 millseconds.
591+
* 2.5, 5, 10, 20, 40 or 60 milliseconds.
592592
* @param channels Number of audio channels. Supported values are 1 and 2.
593593
* @param sampling_rate Audio sampling rate used in this frame. Valid sampling
594594
* rates are 8000, 12000, 16000, 24000, or 48000.

toxcore/tox.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1587,7 +1587,7 @@ void tox_callback_friend_name(Tox *tox, tox_friend_name_cb *callback);
15871587
/**
15881588
* @brief Return the length of the friend's status message.
15891589
*
1590-
* If the friend number isinvalid, the return value is SIZE_MAX.
1590+
* If the friend number is invalid, the return value is SIZE_MAX.
15911591
*/
15921592
size_t tox_friend_get_status_message_size(
15931593
const Tox *tox, Tox_Friend_Number friend_number, Tox_Err_Friend_Query *error);
@@ -2260,7 +2260,7 @@ const char *tox_err_file_send_to_string(Tox_Err_File_Send value);
22602260
* - If the file size was decreased
22612261
* - and sending mode was streaming, the behaviour is as expected.
22622262
* - and sending mode was file, the callback will return 0 at the new
2263-
* (earlier) end-of-file, signalling to the friend that the transfer was
2263+
* (earlier) end-of-file, signaling to the friend that the transfer was
22642264
* cancelled.
22652265
* - If the file contents were modified
22662266
* - at a position before the current read, the two files (local and remote)
@@ -4376,7 +4376,7 @@ uint32_t tox_group_get_number_groups(const Tox *tox);
43764376
* The value returned is equal to the data received by the last
43774377
* `group_privacy_state` callback.
43784378
*
4379-
* @see the `Group chat founder controls` section for the respective set
4379+
* @see the `Group chat Founder controls` section for the respective set
43804380
* function.
43814381
*/
43824382
Tox_Group_Privacy_State tox_group_get_privacy_state(const Tox *tox, Tox_Group_Number group_number,
@@ -4404,7 +4404,7 @@ void tox_callback_group_privacy_state(Tox *tox, tox_group_privacy_state_cb *call
44044404
* The value returned is equal to the data received by the last
44054405
* `group_voice_state` callback.
44064406
*
4407-
* @see the `Group chat founder controls` section for the respective set
4407+
* @see the `Group chat Founder controls` section for the respective set
44084408
* function.
44094409
*/
44104410
Tox_Group_Voice_State tox_group_get_voice_state(const Tox *tox, Tox_Group_Number group_number,
@@ -4433,7 +4433,7 @@ void tox_callback_group_voice_state(Tox *tox, tox_group_voice_state_cb *callback
44334433
* The value returned is equal to the data received by the last
44344434
* `group_topic_lock` callback.
44354435
*
4436-
* @see the `Group chat founder contols` section for the respective set
4436+
* @see the `Group chat Founder controls` section for the respective set
44374437
* function.
44384438
*/
44394439
Tox_Group_Topic_Lock tox_group_get_topic_lock(const Tox *tox, Tox_Group_Number group_number,
@@ -4461,7 +4461,7 @@ void tox_callback_group_topic_lock(Tox *tox, tox_group_topic_lock_cb *callback);
44614461
* The value returned is equal to the data received by the last
44624462
* `group_peer_limit` callback.
44634463
*
4464-
* @see the `Group chat founder controls` section for the respective set
4464+
* @see the `Group chat Founder controls` section for the respective set
44654465
* function.
44664466
*/
44674467
uint16_t tox_group_get_peer_limit(const Tox *tox, Tox_Group_Number group_number, Tox_Err_Group_State_Query *error);

toxcore/tox_private.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ uint16_t tox_dht_get_num_closelist(const Tox *tox);
154154

155155
/**
156156
* This function returns the number of DHT nodes in the closelist,
157-
* that are capable to store annouce data (introduced in version 0.2.18).
157+
* that are capable to store announce data (introduced in version 0.2.18).
158158
*
159159
* @return number
160160
*/

0 commit comments

Comments
 (0)