#1003: Changed comments about Platform.Bible logo to be more generic

paranext · Sep 11, 2024 · 46202cf · 46202cf
1 parent b5b1096
commit 46202cf
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/lib/papi-dts/papi.d.ts b/lib/papi-dts/papi.d.ts
@@ -88,7 +88,7 @@ declare module 'shared/models/web-view.model' {
     /**
      * Url of image to show on the title bar of the tab
      *
-     * Defaults to Platform.Bible logo
+     * Defaults to the software's standard logo.
      */
     iconUrl?: string;
     /** Name of the tab for the WebView */
@@ -3024,7 +3024,7 @@ declare module 'shared/models/docking-framework.model' {
     /**
      * Url of image to show on the title bar of the tab
      *
-     * Defaults to Platform.Bible logo
+     * Defaults to the software's standard logo.
      */
     tabIconUrl?: string;
     /** Text to show on the title bar of the tab */

diff --git a/src/renderer/components/docking/platform-tab-title.component.tsx b/src/renderer/components/docking/platform-tab-title.component.tsx
@@ -11,7 +11,7 @@ type PlatformTabTitleProps = {
   webViewType?: `${string}.${string}`;
   /** Id of the tab this title is on */
   tabId: string;
-  /** Url to image to show on the tab. Defaults to Platform.Bible logo */
+  /** Url to image to show on the tab. Defaults to the software's standard logo. */
   iconUrl?: string;
   /** Text to show on the tab */
   text: string;
@@ -22,7 +22,7 @@ type PlatformTabTitleProps = {
 /**
  * Custom tab title for all tabs in Platform
  *
- * @param iconUrl Url to image to show on the tab. Defaults to Platform.Bible logo
+ * @param iconUrl Url to image to show on the tab. Defaults to the software's standard logo.
  * @param text The text to show on the tab title
  * @param tooltip Text to show when hovering over the tab. Defaults to empty string
  */

diff --git a/src/shared/models/docking-framework.model.ts b/src/shared/models/docking-framework.model.ts
@@ -30,7 +30,7 @@ export type TabInfo = SavedTabInfo & {
   /**
    * Url of image to show on the title bar of the tab
    *
-   * Defaults to Platform.Bible logo
+   * Defaults to the software's standard logo.
    */
   tabIconUrl?: string;
   /** Text to show on the title bar of the tab */

diff --git a/src/shared/models/web-view.model.ts b/src/shared/models/web-view.model.ts
@@ -37,7 +37,7 @@ type WebViewDefinitionBase = {
   /**
    * Url of image to show on the title bar of the tab
    *
-   * Defaults to Platform.Bible logo
+   * Defaults to the software's standard logo.
    */
   iconUrl?: string;
   /** Name of the tab for the WebView */