Adding comments to models and user.model.ts

Author: goncalo.amador

src/app/shared/models/article.model.ts

@@ -1,18 +1,69 @@
+/**
+ * Represents an article with a title, content, and date.
+ *
+ * @interface Article
+ */
 export interface Article {
-  id?: string; // document ID
+  /**
+   * The document ID of the article (optional).
+   * @type {string}
+   */
+  id?: string;
+
+  /**
+   * The title of the article.
+   * @type {string}
+   */
   title: string;
+
+  /**
+   * The content of the article.
+   * @type {string}
+   */
   content: string;
+
+  /**
+   * The date of the article in the format YYYY-MM-DD.
+   * @type {string}
+   */
   date: string;
 }
 
+/**
+ * Represents articles organized by day.
+ *
+ * @interface DayArticles
+ */
 export interface DayArticles {
+  /**
+   * A mapping of dates to an array of articles.
+   * @type {Article[]}
+   */
   [key: string]: Article[];
 }
 
+/**
+ * Represents articles organized by month.
+ *
+ * @interface MonthArticles
+ */
 export interface MonthArticles {
+  /**
+   * A mapping of month strings to DayArticles.
+   * @type {DayArticles}
+   */
   [key: string]: DayArticles;
 }
 
+/**
+ * Represents articles organized by year.
+ *
+ * @interface YearArticles
+ */
 export interface YearArticles {
+  /**
+   * A mapping of year strings to MonthArticles.
+   * @type {MonthArticles}
+   */
   [key: string]: MonthArticles;
 }

src/app/shared/models/contact.model.ts

@@ -1,7 +1,36 @@
+/**
+ * Represents a contact in the organization.
+ *
+ * @interface Contact
+ */
 export interface Contact {
+  /**
+   * The role of the contact within the organization.
+   * @type {string}
+   */
   role: string;
+
+  /**
+   * The name of the contact person (optional).
+   * @type {string}
+   */
   name?: string;
+
+  /**
+   * The email address of the contact person (optional).
+   * @type {string}
+   */
   email?: string;
+
+  /**
+   * The phone number of the contact person (optional).
+   * @type {string}
+   */
   phone?: string;
+
+  /**
+   * The image URL for the contact's profile picture (optional).
+   * @type {string}
+   */
   image?: string;
 }

src/app/shared/models/event.model.ts

@@ -1,5 +1,24 @@
+/**
+ * Represents an event in the organization.
+ *
+ * @interface Event
+ */
 export interface Event {
+  /**
+   * The title of the event.
+   * @type {string}
+   */
   title: string;
-  date: string; // Format: YYYY-MM-DD
+
+  /**
+   * The date of the event in the format YYYY-MM-DD.
+   * @type {string}
+   */
+  date: string;
+
+  /**
+   * A brief description of the event (optional).
+   * @type {string}
+   */
   description?: string;
 }

src/app/shared/models/user.model.ts

@@ -0,0 +1,24 @@
+/**
+ * Represents a user in the system.
+ *
+ * @interface User
+ */
+export interface User {
+  /**
+   * The user's email address.
+   * @type {string}
+   */
+  email: string;
+
+  /**
+   * The user's password.
+   * @type {string}
+   */
+  password: string;
+
+  /**
+   * The recovery password for the user.
+   * @type {string}
+   */
+  recoveryPassword: string;
+}