From 591c6b94301ba4a00313f1fc1ef75f52e295cace Mon Sep 17 00:00:00 2001
From: Gimle Larpes <gimlelarpes@gmail.com>
Date: Fri, 13 Jun 2025 00:59:33 +0200
Subject: [PATCH] Document functions

---
 src/app/atoms/time/Time.jsx         | 12 ++++++++++++
 src/app/components/message/Time.tsx | 12 ++++++++++++
 2 files changed, 24 insertions(+)

diff --git a/src/app/atoms/time/Time.jsx b/src/app/atoms/time/Time.jsx
index 3684fb36..d7bbe439 100644
--- a/src/app/atoms/time/Time.jsx
+++ b/src/app/atoms/time/Time.jsx
@@ -4,6 +4,18 @@ import PropTypes from 'prop-types';
 import dateFormat from 'dateformat';
 import { isInSameDay } from '../../../util/common';
 
+/**
+ * Renders a formatted timestamp.
+ *
+ * Displays the time in hour:minute format if the message is from today or yesterday, unless `fullTime` is true.
+ * For older messages, it shows the date and time.
+ *
+ * @param {number} timestamp - The timestamp to display.
+ * @param {boolean} [fullTime=false] - If true, always show the full date and time.
+ * @param {boolean} hour24Clock - Whether to use 24-hour time format.
+ * @param {string} dateFormatString - Format string for the date part.
+ * @returns {JSX.Element} A <time> element with the formatted date/time.
+ */
 function Time({ timestamp, fullTime, hour24Clock, dateFormatString }) {
   const date = new Date(timestamp);
 
diff --git a/src/app/components/message/Time.tsx b/src/app/components/message/Time.tsx
index f06662fb..3eab5cc2 100644
--- a/src/app/components/message/Time.tsx
+++ b/src/app/components/message/Time.tsx
@@ -9,6 +9,18 @@ export type TimeProps = {
   dateFormatString: string;
 };
 
+/**
+ * Renders a formatted timestamp, supporting compact and full display modes.
+ *
+ * Displays the time in hour:minute format if the message is from today, yesterday, or if `compact` is true.
+ * For older messages, it shows the date and time.
+ *
+ * @param {number} ts - The timestamp to display.
+ * @param {boolean} [compact=false] - If true, always show only the time.
+ * @param {boolean} hour24Clock - Whether to use 24-hour time format.
+ * @param {string} dateFormatString - Format string for the date part.
+ * @returns {React.ReactElement} A <Text as="time"> element with the formatted date/time.
+ */
 export const Time = as<'span', TimeProps & ComponentProps<typeof Text>>(
   ({ compact, hour24Clock, dateFormatString, ts, ...props }, ref) => {
     const formattedTime = timeHourMinute(ts, hour24Clock);