FCE-1008/ensure tsdoc consistency (#241)

## Description

Improves tsdoc quality.


## Types of changes

- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to
      not work as expected)

packages/react-client/src/hooks/devices/useInitializeDevices.ts

@@ -12,6 +12,7 @@ export type UseInitializeDevicesResult = {
 };
 
 /**
+ * Hook allows you to initialize access to the devices before joining the room.
  * @category Devices
  */
 export const useInitializeDevices = (): UseInitializeDevicesResult => {

packages/react-client/src/hooks/internal/useScreenshareManager.ts

@@ -3,7 +3,6 @@ import { useCallback, useEffect, useRef, useState } from "react";
 
 import type { ScreenShareState } from "../../types/internal";
 import type { PeerStatus, TracksMiddleware } from "../../types/public";
-import { getRemoteOrLocalTrack } from "../../utils/track";
 import type { UseScreenshareResult } from "../useScreenShare";
 
 interface ScreenShareManagerProps {
@@ -136,17 +135,12 @@ export const useScreenShareManager = ({
     };
   }, [stopStreaming, fishjamClient, stream]);
 
-  const videoBroadcast = state.stream ? getRemoteOrLocalTrack(fishjamClient, state.trackIds.videoId) : null;
-  const audioBroadcast = state.trackIds?.audioId ? getRemoteOrLocalTrack(fishjamClient, state.trackIds.audioId) : null;
-
   return {
     startStreaming,
     stopStreaming,
     stream,
     videoTrack: mediaVideoTrack,
     audioTrack: mediaAudioTrack,
-    videoBroadcast,
-    audioBroadcast,
     setTracksMiddleware,
     currentTracksMiddleware: state?.tracksMiddleware ?? null,
   };

packages/react-client/src/hooks/useConnection.ts

@@ -47,7 +47,7 @@ export interface UseConnectionResult {
 }
 
 /**
- * Hook allows to to join or leave a room and check the current connection status.
+ * Hook allows to join or leave a room and check the current connection status.
  * @category Connection
  * @returns {UseConnectionResult}
  */

packages/react-client/src/hooks/usePeers.ts

@@ -85,6 +85,7 @@ export type UsePeersResult<PeerMetadata, ServerMetadata> = {
 };
 
 /**
+ * Hook allows to access id, tracks and metadata of the local and remote peers.
  *
  * @category Connection
  * @group Hooks

packages/react-client/src/hooks/useScreenShare.ts

@@ -1,4 +1,4 @@
-import type { Track, TracksMiddleware } from "../types/public";
+import type { TracksMiddleware } from "../types/public";
 import { useFishjamContext } from "./internal/useFishjamContext";
 
 /**
@@ -7,22 +7,45 @@ import { useFishjamContext } from "./internal/useFishjamContext";
  * @group Types
  */
 export type UseScreenshareResult = {
+  /**
+   * Invokes the screen sharing prompt in the user's browser and starts streaming upon approval.
+   */
   startStreaming: (props?: {
     audioConstraints?: boolean | MediaTrackConstraints;
     videoConstraints?: boolean | MediaTrackConstraints;
   }) => Promise<void>;
+  /**
+   * Stops the stream and cancels browser screen sharing.
+   */
   stopStreaming: () => Promise<void>;
+  /**
+   * The MediaStream object containing both tracks.
+   */
   stream: MediaStream | null;
+  /**
+   * The separate video MediaStreamTrack.
+   */
   videoTrack: MediaStreamTrack | null;
+  /**
+   * The separate audio MediaStreamTrack.
+   */
   audioTrack: MediaStreamTrack | null;
-  videoBroadcast: Track | null;
-  audioBroadcast: Track | null;
-  setTracksMiddleware: (middleware: TracksMiddleware | null) => Promise<void>;
+  /**
+   * The middleware currently assigned to process the tracks.
+   * A screenshare may include both audio and video tracks, and this middleware is capable of processing
+   * each track type.
+   */
   currentTracksMiddleware: TracksMiddleware | null;
+  /**
+   * Sets the middleware responsible for processing the tracks.
+   * @param middleware The middleware to set, which can be a TracksMiddleware instance or null to remove the middleware.
+   * @returns A Promise that resolves once the middleware is successfully set.
+   */
+  setTracksMiddleware: (middleware: TracksMiddleware | null) => Promise<void>;
 };
 
 /**
- *
+ * Hook to enable screen sharing within a room and manage the existing stream.
  * @category Devices
  * @group Hooks
  */

packages/react-client/src/hooks/useUpdatePeerMetadata.ts

@@ -4,7 +4,7 @@ import { useCallback } from "react";
 import { useFishjamContext } from "./internal/useFishjamContext";
 
 /**
- * Hook provides a method to update the metadata of the local peer
+ * Hook provides a method to update the metadata of the local peer.
  * @category Connection
  * @group Hooks
  * @returns

packages/react-client/src/hooks/useVAD.ts

@@ -6,7 +6,6 @@ import { useFishjamClientState } from "./internal/useFishjamClientState";
 import { useFishjamContext } from "./internal/useFishjamContext";
 
 /**
- *
  * @param peerIds List of ids of peers to subscribe to for voice activity detection notifications.
  * @category Connection
  * @group Hooks