Doxygen for all of bridge/

Author: stephen-derosa

bridge/include/livekit_bridge/bridge_audio_track.h

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/// @file bridge_audio_track.h
+/// @brief Handle for a published local audio track.
+
 #pragma once
 
 #include <cstdint>

bridge/include/livekit_bridge/bridge_video_track.h

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/// @file bridge_video_track.h
+/// @brief Handle for a published local video track.
+
 #pragma once
 
 #include <cstdint>

bridge/include/livekit_bridge/livekit_bridge.h

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/// @file livekit_bridge.h
+/// @brief High-level bridge API for the LiveKit C++ SDK.
+
 #pragma once
 
 #include "livekit_bridge/bridge_audio_track.h"
@@ -266,8 +269,8 @@ class LiveKitBridge {
   friend class test::CallbackKeyTest;
   friend class test::LiveKitBridgeTest;
 
-  // Composite key for the callback map: (participant_identity, source).
-  // Only one callback can exist per key -- re-registering overwrites.
+  /// Composite key for the callback map: (participant_identity, source).
+  /// Only one callback can exist per key -- re-registering overwrites.
   struct CallbackKey {
     std::string identity;
     livekit::TrackSource source;
@@ -279,33 +282,34 @@ class LiveKitBridge {
     std::size_t operator()(const CallbackKey &k) const;
   };
 
-  // Active reader thread + stream for an incoming track
+  /// Active reader thread + stream for an incoming track.
   struct ActiveReader {
     std::shared_ptr<livekit::AudioStream> audio_stream;
     std::shared_ptr<livekit::VideoStream> video_stream;
     std::thread thread;
     bool is_audio = false;
   };
 
-  // Called by BridgeRoomDelegate when a remote track is subscribed
+  /// Called by BridgeRoomDelegate when a remote track is subscribed.
   void onTrackSubscribed(const std::string &participant_identity,
                          livekit::TrackSource source,
                          const std::shared_ptr<livekit::Track> &track);
 
-  // Called by BridgeRoomDelegate when a remote track is unsubscribed
+  /// Called by BridgeRoomDelegate when a remote track is unsubscribed.
   void onTrackUnsubscribed(const std::string &participant_identity,
                            livekit::TrackSource source);
 
-  // Close the stream and extract the thread for the caller to join
-  // (caller must hold mutex_)
+  /// Extract the thread for the given callback key.
+  /// @pre Caller must hold @c mutex_.
   std::thread extractReaderThread(const CallbackKey &key);
 
-  // Start a reader thread for a subscribed track.
-  // Returns the old reader thread (if any) for the caller to join outside
-  // the lock. (caller must hold mutex_)
+  /// Start a reader thread for a subscribed track.
+  /// @return The reader thread for this track.
+  /// @pre Caller must hold @c mutex_.
   std::thread startAudioReader(const CallbackKey &key,
                                const std::shared_ptr<livekit::Track> &track,
                                AudioFrameCallback cb);
+  /// @copydoc startAudioReader
   std::thread startVideoReader(const CallbackKey &key,
                                const std::shared_ptr<livekit::Track> &track,
                                VideoFrameCallback cb);
@@ -320,20 +324,22 @@ class LiveKitBridge {
   std::unique_ptr<livekit::Room> room_;
   std::unique_ptr<BridgeRoomDelegate> delegate_;
 
-  // Registered callbacks (may be registered before tracks are subscribed)
+  /// Registered callbacks (may be registered before tracks are subscribed).
   std::unordered_map<CallbackKey, AudioFrameCallback, CallbackKeyHash>
       audio_callbacks_;
+  /// @copydoc audio_callbacks_
   std::unordered_map<CallbackKey, VideoFrameCallback, CallbackKeyHash>
       video_callbacks_;
 
-  // Active reader threads for subscribed tracks
+  /// Active reader threads for subscribed tracks.
   std::unordered_map<CallbackKey, ActiveReader, CallbackKeyHash>
       active_readers_;
 
-  // All tracks created by this bridge. The bridge retains a shared_ptr so
-  // it can force-release every track on disconnect() before the room is
-  // destroyed, preventing dangling participant_ pointers.
+  /// All tracks created by this bridge. The bridge retains a shared_ptr so
+  /// it can force-release every track on disconnect() before the room is
+  /// destroyed, preventing dangling @c participant_ pointers.
   std::vector<std::shared_ptr<BridgeAudioTrack>> published_audio_tracks_;
+  /// @copydoc published_audio_tracks_
   std::vector<std::shared_ptr<BridgeVideoTrack>> published_video_tracks_;
 
 };

bridge/src/bridge_audio_track.cpp

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/// @file bridge_audio_track.cpp
+/// @brief Implementation of BridgeAudioTrack.
+
 #include "livekit_bridge/bridge_audio_track.h"
 
 #include "livekit/audio_frame.h"

bridge/src/bridge_room_delegate.cpp

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/// @file bridge_room_delegate.cpp
+/// @brief Implementation of BridgeRoomDelegate event forwarding.
+
 #include "bridge_room_delegate.h"
 
 #include "livekit/remote_participant.h"

bridge/src/bridge_room_delegate.h

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/// @file bridge_room_delegate.h
+/// @brief Internal RoomDelegate forwarding SDK events to LiveKitBridge.
+
 #pragma once
 
 #include "livekit/room_delegate.h"
@@ -32,9 +35,11 @@ class BridgeRoomDelegate : public livekit::RoomDelegate {
 public:
   explicit BridgeRoomDelegate(LiveKitBridge &bridge) : bridge_(bridge) {}
 
+  /// Forwards a track-subscribed event to LiveKitBridge::onTrackSubscribed().
   void onTrackSubscribed(livekit::Room &room,
                          const livekit::TrackSubscribedEvent &ev) override;
 
+  /// Forwards a track-unsubscribed event to LiveKitBridge::onTrackUnsubscribed().
   void onTrackUnsubscribed(livekit::Room &room,
                            const livekit::TrackUnsubscribedEvent &ev) override;
 

bridge/src/bridge_video_track.cpp

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/// @file bridge_video_track.cpp
+/// @brief Implementation of BridgeVideoTrack.
+
 #include "livekit_bridge/bridge_video_track.h"
 
 #include "livekit/local_participant.h"

bridge/src/livekit_bridge.cpp

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/// @file livekit_bridge.cpp
+/// @brief Implementation of the LiveKitBridge high-level API.
+
 #include "livekit_bridge/livekit_bridge.h"
 #include "bridge_room_delegate.h"
 

bridge/tests/test_bridge_audio_track.cpp

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/// @file test_bridge_audio_track.cpp
+/// @brief Unit tests for BridgeAudioTrack.
+
 #include <gtest/gtest.h>
 #include <livekit_bridge/bridge_audio_track.h>
 

bridge/tests/test_bridge_video_track.cpp

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+/// @file test_bridge_video_track.cpp
+/// @brief Unit tests for BridgeVideoTrack.
+
 #include <gtest/gtest.h>
 #include <livekit_bridge/bridge_video_track.h>