From ce59e230f083b6d87aae107ddb86e77362a9e707 Mon Sep 17 00:00:00 2001
From: iphydf <iphydf@users.noreply.github.com>
Date: Tue, 26 Mar 2024 10:36:58 +0000
Subject: [PATCH] docs: Add missing param docs for callbacks.

Also add experimental api warnings on tox_events.h and tox_dispatch.h.
---
 .cirrus.yml            | 3 +++
 toxcore/tox.h          | 3 +++
 toxcore/tox_dispatch.h | 7 +++++++
 toxcore/tox_events.h   | 7 +++++++
 4 files changed, 20 insertions(+)

diff --git a/.cirrus.yml b/.cirrus.yml
index bb477b26ef7..738c2efa8f3 100644
--- a/.cirrus.yml
+++ b/.cirrus.yml
@@ -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
@@ -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
@@ -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
diff --git a/toxcore/tox.h b/toxcore/tox.h
index c3b4ad71b57..b4fd1382d01 100644
--- a/toxcore/tox.h
+++ b/toxcore/tox.h
@@ -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.
  */
@@ -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,
diff --git a/toxcore/tox_dispatch.h b/toxcore/tox_dispatch.h
index 2588065a4dd..29ac66a4126 100644
--- a/toxcore/tox_dispatch.h
+++ b/toxcore/tox_dispatch.h
@@ -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
 
diff --git a/toxcore/tox_events.h b/toxcore/tox_events.h
index 1c9b1b455c2..6bbf13e8ef4 100644
--- a/toxcore/tox_events.h
+++ b/toxcore/tox_events.h
@@ -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