Skip to content

Commit

Permalink
docs: Add missing param docs for callbacks.
Browse files Browse the repository at this point in the history
Also add experimental api warnings on tox_events.h and tox_dispatch.h.
  • Loading branch information
iphydf committed Mar 26, 2024
1 parent 0ec4978 commit 9e9ed77
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .cirrus.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ bazel-opt_task:
configure_script:
- git submodule update --init --recursive
- /src/workspace/tools/inject-repo c-toxcore
- sed -i -e 's/build --config=remote/#&/' /src/workspace/.bazelrc.local
test_all_script:
- cd /src/workspace && bazel test -k
--build_tag_filters=-haskell
Expand All @@ -23,6 +24,7 @@ bazel-dbg_task:
configure_script:
- git submodule update --init --recursive
- /src/workspace/tools/inject-repo c-toxcore
- sed -i -e 's/build --config=remote/#&/' /src/workspace/.bazelrc.local
test_all_script:
- cd /src/workspace && bazel test -k
--build_tag_filters=-haskell
Expand All @@ -40,6 +42,7 @@ cimple_task:
configure_script:
- git submodule update --init --recursive
- /src/workspace/tools/inject-repo c-toxcore
- sed -i -e 's/build --config=remote/#&/' /src/workspace/.bazelrc.local
test_all_script:
- cd /src/workspace && bazel test -k
--build_tag_filters=haskell
Expand Down Expand Up @@ -69,7 +72,7 @@ freebsd_task:
cmake . \
-DMIN_LOGGER_LEVEL=TRACE \
-DMUST_BUILD_TOXAV=ON \
-DNON_HERMETIC_TESTS=ON \
-DNON_HERMETIC_TESTS=OFF \
-DTEST_TIMEOUT_SECONDS=50 \
-DUSE_IPV6=OFF \
-DAUTOTEST=ON
Expand Down
3 changes: 3 additions & 0 deletions toxcore/tox.h
Original file line number Diff line number Diff line change
Expand Up @@ -1866,6 +1866,7 @@ void tox_callback_friend_request(Tox *tox, tox_friend_request_cb *callback);

/**
* @param friend_number The friend number of the friend who sent the message.
* @param type The type of the message (normal, action, ...).
* @param message The message data they sent.
* @param length The size of the message byte array.
*/
Expand Down Expand Up @@ -5021,6 +5022,8 @@ Tox_Group_Number tox_group_invite_accept(
* @param friend_number The friend number of the contact who sent the invite.
* @param invite_data The invite data.
* @param invite_data_length The length of invite_data.
* @param group_name The name of the group. In conferences, this is "title".
* @param group_name_length The length of the group name.
*/
typedef void tox_group_invite_cb(
Tox *tox, Tox_Friend_Number friend_number,
Expand Down
7 changes: 7 additions & 0 deletions toxcore/tox_dispatch.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
* Copyright © 2022 The TokTok team.
*/

/**
* WARNING: This is an experimental API and is subject to change.
*
* At this point, it probably won't change very much anymore, but we may have
* small breaking changes before a stable release.
*/

#ifndef C_TOXCORE_TOXCORE_TOX_DISPATCH_H
#define C_TOXCORE_TOXCORE_TOX_DISPATCH_H

Expand Down
7 changes: 7 additions & 0 deletions toxcore/tox_events.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
* Copyright © 2022-2024 The TokTok team.
*/

/**
* WARNING: This is an experimental API and is subject to change.
*
* At this point, it probably won't change very much anymore, but we may have
* small breaking changes before a stable release.
*/

#ifndef C_TOXCORE_TOXCORE_TOX_EVENTS_H
#define C_TOXCORE_TOXCORE_TOX_EVENTS_H

Expand Down

0 comments on commit 9e9ed77

Please sign in to comment.