[MOB-9676] docs and doc generator

example/src/hooks/useIterableApp.tsx

@@ -47,17 +47,15 @@ interface IterableAppProps {
   loginInProgress?: boolean;
   /** Logs the user out */
   logout: () => void;
-  // eslint-disable-next-line tsdoc/syntax
-  /** TODO: Ask @evantk91 or @Ayyanchira what this is for */
+  /** Should the iterable inbox return to the list of messages? */
   returnToInboxTrigger: boolean;
   /** Sets the API key for the user */
   setApiKey: (value: string) => void;
   /** Sets whether the tab in focus is the `Inbox` tab */
   setIsInboxTab: (value: boolean) => void;
   /** Sets whether the login is in progress */
   setLoginInProgress: (value: boolean) => void;
-  // eslint-disable-next-line tsdoc/syntax
-  /** TODO: Ask @evantk91 or @Ayyanchira what this is for */
+  /** Sets whether the iterable inbox should return to the list of messages */
   setReturnToInboxTrigger: (value: boolean) => void;
   /** Sets the user ID for the user */
   setUserId: (value: string) => void;

src/core/classes/IterableAction.ts

@@ -1,16 +1,17 @@
 /**
  * IterableAction represents an action defined as a response to user events.
+ *
  * It is currently used in push notification actions (open push & action buttons).
  */
 export class IterableAction {
   /** The type of iterable action. */
   type: string;
-  /** Optional string data associated with the IterableAction. */
+  /**
+   * Determines the action.  EG: "open_url", "open_in_app", "deep_link", "join" etc.
+   */
   data?: string;
   /**
-   * TODO: Review
-   * Optional user input string.
-   * This property can be used to store input provided by the user.
+   * Additional info related to the action.
    */
   userInput?: string;
 

src/core/classes/IterableActionContext.ts

@@ -2,17 +2,31 @@ import type { IterableActionSource } from '../enums';
 import { IterableAction } from './IterableAction';
 
 /**
- * TODO: Add description
+ * Information related to an Iterable action.
  */
 export class IterableActionContext {
+  /**
+   * The action associated with the context.
+   */
   action: IterableAction;
+  /**
+   * The origin of the action.  In other words, where was the action triggered?
+   */
   source: IterableActionSource;
 
+  /**
+   * Creates an instance of IterableActionContext.
+   */
   constructor(action: IterableAction, source: IterableActionSource) {
     this.action = action;
     this.source = source;
   }
 
+  /**
+   * Creates an instance of `IterableActionContext` from a dictionary object.
+   *
+   * @returns A new instance of `IterableActionContext` with the provided properties.
+   */
   static fromDict(dict: IterableActionContext): IterableActionContext {
     const action = IterableAction.fromDict(dict.action);
     const source = dict.source;

src/core/classes/IterableEdgeInsets.ts

@@ -1,19 +1,39 @@
 import type { IterableEdgeInsetDetails } from '../types';
 
-// TODO: Add description
-export class IterableEdgeInsets {
+/**
+ * Space around the html content
+ */
+export class IterableEdgeInsets implements IterableEdgeInsetDetails {
   top: number;
   left: number;
   bottom: number;
   right: number;
 
+  /**
+   * Creates an instance of IterableEdgeInsets.
+   *
+   * @param top - The top edge inset.
+   * @param left - The left edge inset.
+   * @param bottom - The bottom edge inset.
+   * @param right - The right edge inset.
+   */
   constructor(top: number, left: number, bottom: number, right: number) {
     this.top = top;
     this.left = left;
     this.bottom = bottom;
     this.right = right;
   }
 
+  /**
+   * Creates an instance of `IterableEdgeInsets` from a dictionary object.
+   *
+   * @param dict - An object containing the edge inset details with properties:
+   *   - `top`: The top edge inset.
+   *   - `left`: The left edge inset.
+   *   - `bottom`: The bottom edge inset.
+   *   - `right`: The right edge inset.
+   * @returns A new instance of `IterableEdgeInsets` initialized with the provided edge inset values.
+   */
   static fromDict(dict: IterableEdgeInsetDetails): IterableEdgeInsets {
     return new IterableEdgeInsets(dict.top, dict.left, dict.bottom, dict.right);
   }

src/core/enums/IterableEventName.ts

@@ -7,8 +7,8 @@ export enum IterableEventName {
   /** Event that fires when a custom action is called */
   handleCustomActionCalled = 'handleCustomActionCalled',
   /**
-   * TODO: Review
-   * Event that fires when an in-app message is shown?
+   * TODO: Rename at some point
+   * Event that fires when an in-app message is shown
    */
   handleInAppCalled = 'handleInAppCalled',
   /** Event that fires when a user attempts to authenticate */

src/core/enums/IterableLogLevel.ts

@@ -1,11 +1,14 @@
 /**
- * Enum representing what level of logs will Android and iOS project be printing
- * on their consoles respectively.
+ * Enum representing the level of logs will Android and iOS projects be using.
  *
- * TODO: Go over what they correspond to in ios/Android with Evan/Akshay
+ * @see [Android Log Levels](https://source.android.com/docs/core/tests/debug/understanding-logging)
+ * @see [iOS Log Levels](https://apple.github.io/swift-log/docs/current/Logging/Structs/Logger/Level.html#/s:7Logging6LoggerV5LevelO4infoyA2EmF)
  */
 export enum IterableLogLevel {
+  /** Appropriate for messages that contain information normally of use only when debugging a program. */
   debug = 1,
+  /** Appropriate for informational messages. */
   info = 2,
+  /** Appropriate for error conditions. */
   error = 3,
 }

src/core/types/IterableEdgeInsetDetails.ts

@@ -1,7 +1,13 @@
-/** TODO: document */
+/**
+ * Space around the html content.
+ */
 export interface IterableEdgeInsetDetails {
+  /** Space at the top of the html content. */
   top: number;
+  /** Space to the left of the html content. */
   left: number;
+  /** Space at the bottom of the html content. */
   bottom: number;
+  /** Space to the right of the html content. */
   right: number;
 }

src/inApp/classes/IterableHtmlInAppContent.ts

@@ -6,17 +6,34 @@ import type {
   IterableInAppContent,
 } from '../types';
 
-// TODO: Add description
+/**
+ * Information about the display of an HTML in-app message.
+ */
 export class IterableHtmlInAppContent implements IterableInAppContent {
+  /** The type of in-app content. */
   type: IterableInAppContentType = IterableInAppContentType.html;
+  /** The space around the in-app content. */
   edgeInsets: IterableEdgeInsets;
+  /** The raw HTML content of the in-app message. */
   html: string;
 
+  /**
+   * Constructs an `IterableHtmlInAppContent` instance with the provided `edgeInsets` and `html`.
+   *
+   * @param edgeInsets The space around the in-app content.
+   * @param html The raw HTML content of the in-app message.
+   */
   constructor(edgeInsets: IterableEdgeInsets, html: string) {
     this.edgeInsets = edgeInsets;
     this.html = html;
   }
 
+  /**
+   * Creates a new `IterableHtmlInAppContent` instance from a raw dictionary representation.
+   *
+   * @param dict The raw dictionary representation of the HTML in-app content.
+   * @returns A new `IterableHtmlInAppContent` instance with the values from the provided dictionary.
+   */
   static fromDict(dict: IterableHtmlInAppContentRaw): IterableHtmlInAppContent {
     return new IterableHtmlInAppContent(
       IterableEdgeInsets.fromDict(dict.edgeInsets),

src/inApp/classes/IterableInAppMessage.ts

@@ -148,9 +148,7 @@ export class IterableInAppMessage {
   }
 
   /**
-   * Determines if the in-app message should be silently saved to the inbox.
-   *
-   * TODO: Double check the definition
+   * Do you want the in-app message to be saved to the inbox without triggering a notification?
    *
    * @returns `true` if the message should be saved to the inbox without triggering a notification; otherwise, `false`.
    */

src/inApp/types/IterableHtmlInAppContentRaw.ts

@@ -1,7 +1,11 @@
 import type { IterableEdgeInsetDetails } from '../../core';
 
-/** The raw in-App content details returned from the server */
+/**
+ * The raw in-App content details returned from the server.
+ */
 export interface IterableHtmlInAppContentRaw {
+  /** The HTML content of the in-App message. */
   edgeInsets: IterableEdgeInsetDetails;
+  /** The HTML content of the in-App message. */
   html: string;
 }

src/inbox/types/IterableInboxImpressionRowInfo.ts

@@ -2,12 +2,8 @@
  * Interface representing the information of an impression row in the Iterable inbox.
  */
 export interface IterableInboxImpressionRowInfo {
-  /**
-   * The message ID of the impression row.
-   */
+  /** The message ID of the impression row. */
   messageId: string;
-  /**
-   * TODO: Ask about this field
-   */
+  /** Do you want the message to show in the inbox list but not as a notification? */
   silentInbox: boolean;
 }