summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJfreegman <jfreegman@gmail.com>2015-07-07 02:05:45 -0400
committerJfreegman <jfreegman@gmail.com>2015-07-07 02:05:45 -0400
commitf3b65bc3dc4f85924ddf7f2cf453924963b5e989 (patch)
tree711d54eab42632c51a2fc0a9e12c8e0babdde0c2
parent1d4552c3c45ea80373ab73c3485fe53e5a3099be (diff)
Fix a couple API doc mistakes
-rw-r--r--other/apidsl/tox.in.h6
-rw-r--r--toxcore/tox.h4
2 files changed, 5 insertions, 5 deletions
diff --git a/other/apidsl/tox.in.h b/other/apidsl/tox.in.h
index 4a0ab950..577515b1 100644
--- a/other/apidsl/tox.in.h
+++ b/other/apidsl/tox.in.h
@@ -627,7 +627,7 @@ uint8_t[size] savedata {
627 * Sends a "get nodes" request to the given bootstrap node with IP, port, and 627 * Sends a "get nodes" request to the given bootstrap node with IP, port, and
628 * public key to setup connections. 628 * public key to setup connections.
629 * 629 *
630 * This function will attempt to connect to the node using UDP. You must use 630 * This function will attempt to connect to the node using UDP. You must use
631 * this function even if ${options.this.udp_enabled} was set to false. 631 * this function even if ${options.this.udp_enabled} was set to false.
632 * 632 *
633 * @param address The hostname or IP address (IPv4 or IPv6) of the node. 633 * @param address The hostname or IP address (IPv4 or IPv6) of the node.
@@ -1209,7 +1209,7 @@ namespace friend {
1209 with error for query; 1209 with error for query;
1210 1210
1211 /** 1211 /**
1212 * Write the name of the friend designated by the given friend number to a byte 1212 * Write the status message of the friend designated by the given friend number to a byte
1213 * array. 1213 * array.
1214 * 1214 *
1215 * Call $size to determine the allocation size for the `status_name` 1215 * Call $size to determine the allocation size for the `status_name`
@@ -1218,7 +1218,7 @@ namespace friend {
1218 * The data written to `status_message` is equal to the data received by the last 1218 * The data written to `status_message` is equal to the data received by the last
1219 * `${event status_message}` callback. 1219 * `${event status_message}` callback.
1220 * 1220 *
1221 * @param name A valid memory region large enough to store the friend's name. 1221 * @param status_message A valid memory region large enough to store the friend's status message.
1222 */ 1222 */
1223 get(uint32_t friend_number) 1223 get(uint32_t friend_number)
1224 with error for query; 1224 with error for query;
diff --git a/toxcore/tox.h b/toxcore/tox.h
index 3b2da2f7..1655d9c1 100644
--- a/toxcore/tox.h
+++ b/toxcore/tox.h
@@ -1283,7 +1283,7 @@ void tox_callback_friend_name(Tox *tox, tox_friend_name_cb *callback, void *user
1283size_t tox_friend_get_status_message_size(const Tox *tox, uint32_t friend_number, TOX_ERR_FRIEND_QUERY *error); 1283size_t tox_friend_get_status_message_size(const Tox *tox, uint32_t friend_number, TOX_ERR_FRIEND_QUERY *error);
1284 1284
1285/** 1285/**
1286 * Write the name of the friend designated by the given friend number to a byte 1286 * Write the status message of the friend designated by the given friend number to a byte
1287 * array. 1287 * array.
1288 * 1288 *
1289 * Call tox_friend_get_status_message_size to determine the allocation size for the `status_name` 1289 * 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
1292 * The data written to `status_message` is equal to the data received by the last 1292 * The data written to `status_message` is equal to the data received by the last
1293 * `friend_status_message` callback. 1293 * `friend_status_message` callback.
1294 * 1294 *
1295 * @param name A valid memory region large enough to store the friend's name. 1295 * @param status_message A valid memory region large enough to store the friend's status message.
1296 */ 1296 */
1297bool tox_friend_get_status_message(const Tox *tox, uint32_t friend_number, uint8_t *status_message, 1297bool tox_friend_get_status_message(const Tox *tox, uint32_t friend_number, uint8_t *status_message,
1298 TOX_ERR_FRIEND_QUERY *error); 1298 TOX_ERR_FRIEND_QUERY *error);