chore(utils/ui): jsdocs

Signed-off-by: Adam Setch <adam.setch@outlook.com>

Author: setchy

src/renderer/utils/ui/cn.ts

@@ -1,6 +1,12 @@
 import { type ClassValue, clsx } from 'clsx';
 import { twMerge } from 'tailwind-merge';
 
+/**
+ * Merges class names using clsx and resolves Tailwind CSS conflicts with tailwind-merge.
+ *
+ * @param inputs - One or more class values (strings, arrays, objects, etc.).
+ * @returns A single merged class name string with Tailwind conflicts resolved.
+ */
 export function cn(...inputs: ClassValue[]) {
   return twMerge(clsx(...inputs));
 }

src/renderer/utils/ui/display.ts

@@ -12,6 +12,14 @@ export interface ParsedCodePart {
   content: string;
 }
 
+/**
+ * Returns the appropriate chevron icon and accessible label for a collapsible section.
+ *
+ * @param hasNotifications - Whether the section has any notifications to display.
+ * @param isVisible - Whether the section is currently expanded/visible.
+ * @param type - The type of section (`'account'` or `'repository'`).
+ * @returns A `Chevron` object containing the icon component and its accessible label.
+ */
 export function getChevronDetails(
   hasNotifications: boolean,
   isVisible: boolean,

src/renderer/utils/ui/emojis.ts

@@ -2,6 +2,13 @@ import twemoji, { type TwemojiOptions } from '@discordapp/twemoji';
 
 const EMOJI_FORMAT = 'svg';
 
+/**
+ * Parses a text string and replaces Unicode emoji characters with local SVG `<img>` tags.
+ * The SVG file paths are resolved from the Electron main process.
+ *
+ * @param text - The text string potentially containing emoji characters.
+ * @returns Promise resolving to an HTML string with emojis replaced by `<img>` elements.
+ */
 export async function convertTextToEmojiImgHtml(text: string): Promise<string> {
   const directory = await window.gitify.twemojiDirectory();
 

src/renderer/utils/ui/zoom.ts

@@ -40,29 +40,29 @@ export function zoomLevelToPercentage(zoom: number): Percentage {
 }
 
 /**
- * Returns true if can decrease zoom percentage further.
+ * Returns `true` if the zoom can be decreased by one step.
  *
  * @param zoomPercentage - The current zoom percentage.
- * @returns `true` if decrementing by one step stays at or above the minimum.
+ * @returns `true` if decreasing by one step would remain at or above the minimum, `false` otherwise.
  */
 export function canDecreaseZoom(zoomPercentage: Percentage) {
   return zoomPercentage - ZOOM_STEP >= MINIMUM_ZOOM_PERCENTAGE;
 }
 
 /**
- * Returns true if can increase zoom percentage further.
+ * Returns `true` if the zoom can be increased by one step.
  *
  * @param zoomPercentage - The current zoom percentage.
- * @returns `true` if incrementing by one step stays at or below the maximum.
+ * @returns `true` if increasing by one step would remain at or below the maximum, `false` otherwise.
  */
 export function canIncreaseZoom(zoomPercentage: Percentage) {
   return zoomPercentage + ZOOM_STEP <= MAXIMUM_ZOOM_PERCENTAGE;
 }
 
 /**
- * Decrease zoom by one step amount, if possible.
+ * Decreases the zoom level by one step if possible, then applies it via the Electron zoom bridge.
  *
- * @param zoomPercentage - The current zoom percentage.
+ * @param zoomPercentage - Current zoom percentage.
  */
 export function decreaseZoom(zoomPercentage: Percentage) {
   if (canDecreaseZoom(zoomPercentage)) {
@@ -73,9 +73,9 @@ export function decreaseZoom(zoomPercentage: Percentage) {
 }
 
 /**
- * Increase zoom by one step amount, if possible.
+ * Increases the zoom level by one step if possible, then applies it via the Electron zoom bridge.
  *
- * @param zoomPercentage - The current zoom percentage.
+ * @param zoomPercentage - Current zoom percentage.
  */
 export function increaseZoom(zoomPercentage: Percentage) {
   if (canIncreaseZoom(zoomPercentage)) {
@@ -86,7 +86,7 @@ export function increaseZoom(zoomPercentage: Percentage) {
 }
 
 /**
- * Reset zoom level
+ * Resets the zoom level to the recommended default, then applies it via the Electron zoom bridge.
  */
 export function resetZoomLevel() {
   window.gitify.zoom.setLevel(