add helpful comment

jicruz96 · jicruz96 · commit e83b33515121 · 2025-07-31T18:57:42.000-04:00
diff --git a/components/layout.tsx b/components/layout.tsx
@@ -13,6 +13,12 @@ export const PageContainer: FC<React.PropsWithChildren<unknown>> = ({
   return <div className={`vh-100 d-flex flex-column`}>{children}</div>
 }
 
+/**
+ * Props for the Layout component.
+ *
+ * @property {string} [titleI18nKey] - The internationalization key for the title.
+ * This key must be defined in the `common.json` namespace.
+ */
 export type LayoutProps = {
   titleI18nKey?: string
 }

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,12 @@ export const PageContainer: FC<React.PropsWithChildren<unknown>> = ({`
`13`	`13`	return <div className={`vh-100 d-flex flex-column`}>{children}</div>
`14`	`14`	`}`
`15`	`15`
	`16`	`+/**`
	`17`	`+ * Props for the Layout component.`
	`18`	`+ *`
	`19`	`+ * @property {string} [titleI18nKey] - The internationalization key for the title.`
	`20`	+ * This key must be defined in the `common.json` namespace.
	`21`	`+ */`
`16`	`22`	`export type LayoutProps = {`
`17`	`23`	`titleI18nKey?: string`
`18`	`24`	`}`