diff options
author | irungentoo <irungentoo@gmail.com> | 2013-08-23 11:02:01 -0400 |
---|---|---|
committer | irungentoo <irungentoo@gmail.com> | 2013-08-23 11:02:01 -0400 |
commit | eb0bb66a204cf65929bf3d7e2176b98494a2663d (patch) | |
tree | b27e94907902c652e2b707e6120ba5d5b31a180d /core | |
parent | 0f77a2d131ca0b96e9b6c6e2e516ed0d47884e27 (diff) |
Fixed some comments.
Diffstat (limited to 'core')
-rw-r--r-- | core/tox.h | 26 |
1 files changed, 13 insertions, 13 deletions
@@ -97,15 +97,15 @@ void tox_getaddress(Tox *tox, uint8_t *address); | |||
97 | * address is the address of the friend (returned by getaddress of the friend you wish to add) it must be FRIEND_ADDRESS_SIZE bytes. TODO: add checksum. | 97 | * address is the address of the friend (returned by getaddress of the friend you wish to add) it must be FRIEND_ADDRESS_SIZE bytes. TODO: add checksum. |
98 | * data is the data and length is the length | 98 | * data is the data and length is the length |
99 | * returns the friend number if success | 99 | * returns the friend number if success |
100 | * return FA_TOOLONG if message length is too long | 100 | * return TOX_FA_TOOLONG if message length is too long |
101 | * return FAERR_NOMESSAGE if no message (message length must be >= 1 byte) | 101 | * return TOX_FAERR_NOMESSAGE if no message (message length must be >= 1 byte) |
102 | * return FAERR_OWNKEY if user's own key | 102 | * return TOX_FAERR_OWNKEY if user's own key |
103 | * return FAERR_ALREADYSENT if friend request already sent or already a friend | 103 | * return TOX_FAERR_ALREADYSENT if friend request already sent or already a friend |
104 | * return FAERR_UNKNOWN for unknown error | 104 | * return TOX_FAERR_UNKNOWN for unknown error |
105 | * return FAERR_BADCHECKSUM if bad checksum in address | 105 | * return TOX_FAERR_BADCHECKSUM if bad checksum in address |
106 | * return FAERR_SETNEWNOSPAM if the friend was already there but the nospam was different | 106 | * return TOX_FAERR_SETNEWNOSPAM if the friend was already there but the nospam was different |
107 | * (the nospam for that friend was set to the new one) | 107 | * (the nospam for that friend was set to the new one) |
108 | * return FAERR_NOMEM if increasing the friend list size fails | 108 | * return TOX_FAERR_NOMEM if increasing the friend list size fails |
109 | */ | 109 | */ |
110 | int tox_addfriend(Tox *tox, uint8_t *address, uint8_t *data, uint16_t length); | 110 | int tox_addfriend(Tox *tox, uint8_t *address, uint8_t *data, uint16_t length); |
111 | 111 | ||
@@ -128,11 +128,11 @@ int tox_getclient_id(Tox *tox, int friend_id, uint8_t *client_id); | |||
128 | /* remove a friend */ | 128 | /* remove a friend */ |
129 | int tox_delfriend(Tox *tox, int friendnumber); | 129 | int tox_delfriend(Tox *tox, int friendnumber); |
130 | 130 | ||
131 | /* return 4 if friend is online | 131 | /* return TOX_FRIEND_ONLINE if friend is online |
132 | return 3 if friend is confirmed | 132 | return TOX_FRIEND_CONFIRMED if friend is confirmed |
133 | return 2 if the friend request was sent | 133 | return TOX_FRIEND_REQUESTED if the friend request was sent |
134 | return 1 if the friend was added | 134 | return TOX_FRIEND_ADDED if the friend was added |
135 | return 0 if there is no friend with that number */ | 135 | return TOX_NOFRIEND if there is no friend with that number */ |
136 | int tox_friendstatus(Tox *tox, int friendnumber); | 136 | int tox_friendstatus(Tox *tox, int friendnumber); |
137 | 137 | ||
138 | /* send a text chat message to an online friend | 138 | /* send a text chat message to an online friend |