Skip to content

Commit

Permalink
updating jsdocs generation
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomas-Gallant committed Oct 27, 2024
1 parent b23aaee commit 7842600
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions app/Components/SudokuBoard/Components/Cell.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@ const Cell = (props: RenderCellProps) => {
const cellSize = getCellSize();

/**
* Generates note text for each note if the note exists in the cell.
* @param noteIndex The index of the note.
* @returns void or a text component for the note index of a cell.
* Generates a styled text component for a note index within a cell.
*
* @param noteIndex - The index of the note to be rendered.
* @param noteColor - An array of colors corresponding to each note index.
* @returns A Text component with the specified style if the note index is present in the entry.
*/
const getNoteContents = (noteIndex: number, noteColor: string[]) => {
if (entry.includes(noteIndex)) {
Expand Down

0 comments on commit 7842600

Please sign in to comment.