cleanup: Rename group to conference in groupav documentation.

Author: iphydf

toxav/groupav.c

@@ -442,7 +442,7 @@ static int handle_group_audio_packet(void *object, uint32_t conference_number, u
     return 0;
 }
 
-/** @brief Enable A/V in a groupchat.
+/** @brief Enable A/V in a conference.
  *
  * @retval 0 on success.
  * @retval -1 on failure.
@@ -484,7 +484,7 @@ int groupchat_enable_av(const Logger *log, Tox *tox, Group_Chats *g_c, uint32_t
     return 0;
 }
 
-/** @brief Disable A/V in a groupchat.
+/** @brief Disable A/V in a conference.
  *
  * @retval 0 on success.
  * @retval -1 on failure.
@@ -525,15 +525,15 @@ int groupchat_disable_av(const Group_Chats *g_c, uint32_t conference_number)
     return 0;
 }
 
-/** Return whether A/V is enabled in the groupchat. */
+/** Return whether A/V is enabled in the conference. */
 bool groupchat_av_enabled(const Group_Chats *g_c, uint32_t conference_number)
 {
     return group_get_object(g_c, conference_number) != nullptr;
 }
 
 /** @brief Create and connect to a new toxav group.
  *
- * @return group number on success.
+ * @return conference number on success.
  * @retval -1 on failure.
  */
 int add_av_groupchat(const Logger *log, Tox *tox, Group_Chats *g_c, audio_data_cb *audio_callback, void *userdata)
@@ -554,13 +554,13 @@ int add_av_groupchat(const Logger *log, Tox *tox, Group_Chats *g_c, audio_data_c
 
 /** @brief Join a AV group (you need to have been invited first).
  *
- * @return group number on success
+ * @return conference number on success
  * @retval -1 on failure.
  */
-int join_av_groupchat(const Logger *log, Tox *tox, Group_Chats *g_c, uint32_t friendnumber, const uint8_t *data,
+int join_av_groupchat(const Logger *log, Tox *tox, Group_Chats *g_c, uint32_t peer_number, const uint8_t *data,
                       uint16_t length, audio_data_cb *audio_callback, void *userdata)
 {
-    const int conference_number = join_groupchat(g_c, friendnumber, GROUPCHAT_TYPE_AV, data, length);
+    const int conference_number = join_groupchat(g_c, peer_number, GROUPCHAT_TYPE_AV, data, length);
 
     if (conference_number == -1) {
         return -1;
@@ -574,7 +574,7 @@ int join_av_groupchat(const Logger *log, Tox *tox, Group_Chats *g_c, uint32_t fr
     return conference_number;
 }
 
-/** @brief Send an encoded audio packet to the group chat.
+/** @brief Send an encoded audio packet to the conference.
  *
  * @retval 0 on success.
  * @retval -1 on failure.
@@ -609,7 +609,7 @@ static int send_audio_packet(const Group_Chats *g_c, uint32_t conference_number,
     return 0;
 }
 
-/** @brief Send audio to the group chat.
+/** @brief Send audio to the conference.
  *
  * @retval 0 on success.
  * @retval -1 on failure.

toxav/groupav.h

@@ -21,44 +21,44 @@ typedef void audio_data_cb(void *tox, uint32_t conference_number, uint32_t peern
 
 /** @brief Create and connect to a new toxav group.
  *
- * @return group number on success.
+ * @return conference number on success.
  * @retval -1 on failure.
  */
 int add_av_groupchat(const Logger *log, Tox *tox, Group_Chats *g_c, audio_data_cb *audio_callback, void *userdata);
 
 /** @brief Join a AV group (you need to have been invited first).
  *
- * @return group number on success
+ * @return conference number on success
  * @retval -1 on failure.
  */
-int join_av_groupchat(const Logger *log, Tox *tox, Group_Chats *g_c, uint32_t friendnumber, const uint8_t *data,
+int join_av_groupchat(const Logger *log, Tox *tox, Group_Chats *g_c, uint32_t peer_number, const uint8_t *data,
                       uint16_t length, audio_data_cb *audio_callback, void *userdata);
 
 
-/** @brief Send audio to the group chat.
+/** @brief Send audio to the conference.
  *
  * @retval 0 on success.
  * @retval -1 on failure.
  */
 int group_send_audio(const Group_Chats *g_c, uint32_t conference_number, const int16_t *pcm, unsigned int samples, uint8_t channels,
                      uint32_t sample_rate);
 
-/** @brief Enable A/V in a groupchat.
+/** @brief Enable A/V in a conference.
  *
  * @retval 0 on success.
  * @retval -1 on failure.
  */
 int groupchat_enable_av(const Logger *log, Tox *tox, Group_Chats *g_c, uint32_t conference_number,
                         audio_data_cb *audio_callback, void *userdata);
 
-/** @brief Disable A/V in a groupchat.
+/** @brief Disable A/V in a conference.
  *
  * @retval 0 on success.
  * @retval -1 on failure.
  */
 int groupchat_disable_av(const Group_Chats *g_c, uint32_t conference_number);
 
-/** Return whether A/V is enabled in the groupchat. */
+/** Return whether A/V is enabled in the conference. */
 bool groupchat_av_enabled(const Group_Chats *g_c, uint32_t conference_number);
 
 #endif // C_TOXCORE_TOXAV_GROUPAV_H