StarMirror/toxcore
1
0
Fork 0
mirror of https://github.com/irungentoo/toxcore.git synced 2024-03-22 13:30:51 +08:00
Code Issues Projects Releases Wiki Activity

Fix a couple API doc mistakes

Browse Source
This commit is contained in:
Jfreegman 2015-07-07 02:05:45 -04:00
parent 1d4552c3c4
commit f3b65bc3dc
No known key found for this signature in database
GPG Key ID: 3627F3144076AE63
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
other/apidsl/tox.in.h
View File

@ -627,7 +627,7 @@ uint8_t[size] savedata {
* Sends a "get nodes" request to the given bootstrap node with IP, port, and * Sends a "get nodes" request to the given bootstrap node with IP, port, and
* public key to setup connections. * public key to setup connections.
* *
* This function will attempt to connect to the node using UDP. You must use * This function will attempt to connect to the node using UDP. You must use
* this function even if ${options.this.udp_enabled} was set to false. * this function even if ${options.this.udp_enabled} was set to false.
* *
* @param address The hostname or IP address (IPv4 or IPv6) of the node. * @param address The hostname or IP address (IPv4 or IPv6) of the node.
@ -1209,7 +1209,7 @@ namespace friend {
with error for query; with error for query;
/** /**
* Write the name of the friend designated by the given friend number to a byte * Write the status message of the friend designated by the given friend number to a byte
* array. * array.
* *
* Call $size to determine the allocation size for the `status_name` * Call $size to determine the allocation size for the `status_name`
@ -1218,7 +1218,7 @@ namespace friend {
* The data written to `status_message` is equal to the data received by the last * The data written to `status_message` is equal to the data received by the last
* `${event status_message}` callback. * `${event status_message}` callback.
* *
* @param name A valid memory region large enough to store the friend's name. * @param status_message A valid memory region large enough to store the friend's status message.
*/ */
get(uint32_t friend_number) get(uint32_t friend_number)
with error for query; with error for query;

4
toxcore/tox.h
View File

@ -1283,7 +1283,7 @@ void tox_callback_friend_name(Tox *tox, tox_friend_name_cb *callback, void *user
size_t tox_friend_get_status_message_size(const Tox *tox, uint32_t friend_number, TOX_ERR_FRIEND_QUERY *error); size_t tox_friend_get_status_message_size(const Tox *tox, uint32_t friend_number, TOX_ERR_FRIEND_QUERY *error);
/** /**
* Write the name of the friend designated by the given friend number to a byte * Write the status message of the friend designated by the given friend number to a byte
* array. * array.
* *
* Call tox_friend_get_status_message_size to determine the allocation size for the `status_name` * Call tox_friend_get_status_message_size to determine the allocation size for the `status_name`
@ -1292,7 +1292,7 @@ size_t tox_friend_get_status_message_size(const Tox *tox, uint32_t friend_number
* The data written to `status_message` is equal to the data received by the last * The data written to `status_message` is equal to the data received by the last
* `friend_status_message` callback. * `friend_status_message` callback.
* *
* @param name A valid memory region large enough to store the friend's name. * @param status_message A valid memory region large enough to store the friend's status message.
*/ */
bool tox_friend_get_status_message(const Tox *tox, uint32_t friend_number, uint8_t *status_message, bool tox_friend_get_status_message(const Tox *tox, uint32_t friend_number, uint8_t *status_message,
TOX_ERR_FRIEND_QUERY *error); TOX_ERR_FRIEND_QUERY *error);