Standardize documentation across all *.tsx files

- Add file-level JSDoc comments to components that were missing them
- Ensure consistent documentation format across all components
- Improve code maintainability and readability
This commit is contained in:
2025-03-22 19:53:09 +01:00
parent b1699a74bc
commit 1aeef10ebe
7 changed files with 49 additions and 0 deletions
+7
View File
@@ -1,3 +1,10 @@
/**
* @file App.tsx
* @description Main application component for the PowerPoint toolbox add-in.
* This component serves as the container for all tool components and provides
* a context for status messages and processing state that can be used by child components.
*/
import * as React from "react";
import { useEffect, useState } from "react";
import MatchSizes from "./MatchSizes";
+7
View File
@@ -1,3 +1,10 @@
/**
* @file InsertTitles.tsx
* @description Component that provides functionality to collect and insert slide titles
* from all slides in a PowerPoint presentation into a selected text box. This allows users
* to quickly generate a table of contents or agenda slide with all presentation titles.
*/
import * as React from "react";
import { TextBulletListRegular } from "@fluentui/react-icons";
import { useStatusContext } from "./App";
@@ -1,3 +1,10 @@
/**
* @file MatchProperties.tsx
* @description Component that provides functionality to match visual properties between shapes
* in PowerPoint presentations. This allows users to copy line, fill, and text properties from
* one shape to multiple other shapes, ensuring consistent styling across elements.
*/
import * as React from "react";
import { ColorRegular } from "@fluentui/react-icons";
import { useStatusContext } from "./App";
+7
View File
@@ -1,3 +1,10 @@
/**
* @file MatchSizes.tsx
* @description Component that provides functionality to match dimensions between shapes
* in PowerPoint presentations. This allows users to make multiple shapes the same width,
* height, or both dimensions, based on the first selected shape.
*/
import * as React from "react";
import { ArrowFitInRegular, ArrowMaximizeRegular, ArrowMinimizeRegular } from "@fluentui/react-icons";
import { useStatusContext } from "./App";
@@ -1,3 +1,10 @@
/**
* @file ProgressBarButtons.tsx
* @description Component that provides functionality to add and remove progress bars
* on PowerPoint slides. The progress bars visually indicate the current position within
* the presentation, with colored segments showing completed and upcoming slides.
*/
import * as React from "react";
import {
Button,
+7
View File
@@ -1,3 +1,10 @@
/**
* @file RoundImage.tsx
* @description Component that provides functionality to create circular or rounded images
* in PowerPoint presentations. This tool creates a mask shape that can be used with
* PowerPoint's built-in shape intersection feature to crop images into a circular shape.
*/
import * as React from "react";
import { CircleRegular } from "@fluentui/react-icons";
import { useStatusContext } from "./App";
@@ -1,3 +1,10 @@
/**
* @file SwapPositions.tsx
* @description Component that provides functionality to swap the positions of two selected shapes
* in PowerPoint presentations. This allows users to quickly exchange the locations of two objects
* while maintaining their individual properties and content.
*/
import * as React from "react";
import { ArrowSwapRegular } from "@fluentui/react-icons";
import { useStatusContext } from "./App";