chore: Tie down the use of doxygen comments.

These should only be used before a toplevel thing that can be commented on.
TokTok · Dec 15, 2021 · 11ea15d · 11ea15d
1 parent d9ab919
commit 11ea15d
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 24 deletions.
diff --git a/toxav/audio.c b/toxav/audio.c
@@ -164,9 +164,9 @@ void ac_iterate(ACSession *ac)
 
             ac->lp_channel_count = opus_packet_get_nb_channels(msg->data + 4);
 
-            /** NOTE: even though OPUS supports decoding mono frames with stereo decoder and vice versa,
-              * it didn't work quite well.
-              */
+            /* NOTE: even though OPUS supports decoding mono frames with stereo decoder and vice versa,
+             * it didn't work quite well.
+             */
             if (!reconfigure_audio_decoder(ac, ac->lp_sampling_rate, ac->lp_channel_count)) {
                 LOGGER_WARNING(ac->log, "Failed to reconfigure decoder!");
                 free(msg);

diff --git a/toxav/rtp.c b/toxav/rtp.c
@@ -800,7 +800,7 @@ int rtp_send_data(RTPSession *session, const uint8_t *data, uint32_t length,
     rdata[0] = session->payload_type;  // packet id == payload_type
 
     if (MAX_CRYPTO_DATA_SIZE > (length + RTP_HEADER_SIZE + 1)) {
-        /**
+        /*
          * The length is lesser than the maximum allowed length (including header)
          * Send the packet in single piece.
          */
@@ -814,7 +814,7 @@ int rtp_send_data(RTPSession *session, const uint8_t *data, uint32_t length,
             net_kill_strerror(netstrerror);
         }
     } else {
-        /**
+        /*
          * The length is greater than the maximum allowed length (including header)
          * Send the packet in multiple pieces.
          */

diff --git a/toxav/toxav.c b/toxav/toxav.c
@@ -66,11 +66,15 @@ typedef struct ToxAVCall_s {
 
 /** Decode time statistics */
 typedef struct DecodeTimeStats_s {
-    int32_t count; /** Measure count */
-    int32_t total; /** Last cycle total */
-    int32_t average; /** Average decoding time in ms */
-
-    uint32_t interval; /** Calculated iteration interval */
+    /** Measure count */
+    int32_t count;
+    /** Last cycle total */
+    int32_t total;
+    /** Average decoding time in ms */
+    int32_t average;
+
+    /** Calculated iteration interval */
+    uint32_t interval;
 } DecodeTimeStats;
 
 struct ToxAV {
@@ -106,7 +110,8 @@ struct ToxAV {
     /* keep track of decode times for audio and video */
     DecodeTimeStats audio_stats;
     DecodeTimeStats video_stats;
-    Mono_Time *toxav_mono_time; /** ToxAV's own mono_time instance */
+    /** ToxAV's own mono_time instance */
+    Mono_Time *toxav_mono_time;
 };
 
 static void callback_bwc(BWController *bwc, uint32_t friend_number, float loss, void *user_data);

diff --git a/toxav/toxav_old.c b/toxav/toxav_old.c
@@ -3,7 +3,7 @@
  * Copyright © 2013-2015 Tox project.
  */
 
-/**
+/*
  * This file contains the group chats code for the backwards compatibility.
  */
 

diff --git a/toxcore/Messenger.c b/toxcore/Messenger.c
@@ -974,7 +974,7 @@ static int write_cryptpacket_id(const Messenger *m, int32_t friendnumber, uint8_
                              m->friendlist[friendnumber].friendcon_id), packet, length + 1, congestion_control) != -1;
 }
 
-/** CONFERENCES */
+/*** CONFERENCES */
 
 
 /* Set the callback for conference invites.
@@ -995,7 +995,7 @@ int send_conference_invite_packet(const Messenger *m, int32_t friendnumber, cons
     return write_cryptpacket_id(m, friendnumber, PACKET_ID_INVITE_CONFERENCE, data, length, 0);
 }
 
-/** FILE SENDING */
+/*** FILE SENDING */
 
 
 /* Set the callback for file send requests.

diff --git a/toxcore/Messenger.h b/toxcore/Messenger.h
@@ -550,7 +550,7 @@ void m_callback_connectionstatus_internal_av(Messenger *m, m_friend_connectionst
  */
 void m_callback_core_connection(Messenger *m, m_self_connection_status_cb *function);
 
-/** CONFERENCES */
+/*** CONFERENCES */
 
 /* Set the callback for conference invites.
  */
@@ -563,7 +563,7 @@ void m_callback_conference_invite(Messenger *m, m_conference_invite_cb *function
  */
 int send_conference_invite_packet(const Messenger *m, int32_t friendnumber, const uint8_t *data, uint16_t length);
 
-/** FILE SENDING */
+/*** FILE SENDING */
 
 
 /* Set the callback for file send requests.
@@ -645,7 +645,7 @@ int file_seek(const Messenger *m, int32_t friendnumber, uint32_t filenumber, uin
 int file_data(const Messenger *m, int32_t friendnumber, uint32_t filenumber, uint64_t position, const uint8_t *data,
               uint16_t length);
 
-/** A/V related */
+/*** A/V related */
 
 /* Set the callback for msi packets.
  */
@@ -666,7 +666,7 @@ int m_msi_packet(const Messenger *m, int32_t friendnumber, const uint8_t *data,
 int m_callback_rtp_packet(Messenger *m, int32_t friendnumber, uint8_t byte,
                           m_lossy_rtp_packet_cb *function, void *object);
 
-/** CUSTOM PACKETS */
+/*** CUSTOM PACKETS */
 
 /* Set handlers for custom lossy packets.
  *
@@ -701,7 +701,7 @@ void custom_lossless_packet_registerhandler(Messenger *m, m_friend_lossless_pack
  */
 int send_custom_lossless_packet(const Messenger *m, int32_t friendnumber, const uint8_t *data, uint32_t length);
 
-/** Messenger constructor/destructor/operations. */
+/*** Messenger constructor/destructor/operations. */
 
 typedef enum Messenger_Error {
     MESSENGER_ERROR_NONE,

diff --git a/toxcore/net_crypto.c b/toxcore/net_crypto.c
@@ -722,7 +722,7 @@ static int send_packet_to(Net_Crypto *c, int crypt_connection_id, const uint8_t
     return -1;
 }
 
-/** START: Array Related functions */
+/*** START: Array Related functions */
 
 
 /* Return number of packets in array

diff --git a/toxcore/net_crypto.h b/toxcore/net_crypto.h
@@ -16,9 +16,9 @@
 
 #include <pthread.h>
 
-/** Crypto payloads. */
+/*** Crypto payloads. */
 
-/** Ranges. */
+/*** Ranges. */
 
 /* Packets in this range are reserved for net_crypto internal use. */
 #define PACKET_ID_RANGE_RESERVED_START 0
@@ -41,7 +41,7 @@
 #define PACKET_ID_RANGE_LOSSY_CUSTOM_END 254
 #define PACKET_ID_RANGE_LOSSY_END 254
 
-/** Messages. */
+/*** Messages. */
 
 #define PACKET_ID_PADDING 0 // Denotes padding
 #define PACKET_ID_REQUEST 1 // Used to request unreceived packets

diff --git a/toxcore/state.h b/toxcore/state.h
@@ -3,7 +3,7 @@
  * Copyright © 2014 Tox project.
  */
 
-/**
+/*
  * The state module is responsible for parsing the Tox save data format and for
  * saving state in that format.
  *
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,7 +3,7 @@ @@
      * Copyright © 2013-2015 Tox project.
      */
-    /**
+    /*
      * This file contains the group chats code for the backwards compatibility.
      */
@@ Expand Down @@