From d349492b46f071383e6d5abf29744519a8654e14 Mon Sep 17 00:00:00 2001
From: Eric Liu <ericyl.us@gmail.com>
Date: Sat, 19 Feb 2022 18:40:33 -0800
Subject: [PATCH] fix: use `@component` comments for deprecation notices

---
 src/Icon/Icon.svelte                               | 11 +++++------
 src/Icon/IconSkeleton.svelte                       |  9 ++++-----
 src/Notification/NotificationTextDetails.svelte    |  9 ++++-----
 src/ToggleSmall/ToggleSmall.svelte                 | 11 +++++------
 src/ToggleSmall/ToggleSmallSkeleton.svelte         | 11 +++++------
 src/UIShell/GlobalHeader/HeaderActionSearch.svelte | 10 ++++------
 6 files changed, 27 insertions(+), 34 deletions(-)

diff --git a/src/Icon/Icon.svelte b/src/Icon/Icon.svelte
index 7159b029..0726a79a 100644
--- a/src/Icon/Icon.svelte
+++ b/src/Icon/Icon.svelte
@@ -1,10 +1,4 @@
 <script>
-  /**
-   * @deprecated
-   * This component will be removed in version 1.0.0.
-   * Use icons from "carbon-icons-svelte" instead
-   */
-
   /**
    * @extends {"./IconSkeleton.svelte"} IconSkeletonProps
    * @restProps {svg}
@@ -22,6 +16,11 @@
   import IconSkeleton from "./IconSkeleton.svelte";
 </script>
 
+<!-- @component
+@deprecated This component is deprecated.
+Use icons from "carbon-icons-svelte" instead.
+-->
+
 {#if skeleton}
   <IconSkeleton
     {...$$restProps}
diff --git a/src/Icon/IconSkeleton.svelte b/src/Icon/IconSkeleton.svelte
index 5dd7bbca..bb65630a 100644
--- a/src/Icon/IconSkeleton.svelte
+++ b/src/Icon/IconSkeleton.svelte
@@ -1,13 +1,12 @@
 <script>
-  /**
-   * @deprecated
-   * This component will be removed in version 1.0.0.
-   */
-
   /** Set the size of the icon */
   export let size = 16;
 </script>
 
+<!-- @component
+@deprecated This component is deprecated.
+-->
+
 <!-- svelte-ignore a11y-mouse-events-have-key-events -->
 <div
   class:bx--icon--skeleton="{true}"
diff --git a/src/Notification/NotificationTextDetails.svelte b/src/Notification/NotificationTextDetails.svelte
index c3fd8fe7..a2d96980 100644
--- a/src/Notification/NotificationTextDetails.svelte
+++ b/src/Notification/NotificationTextDetails.svelte
@@ -1,9 +1,4 @@
 <script>
-  /**
-   * @deprecated
-   * This component will be removed in version 1.0.0.
-   */
-
   /**
    * Set the type of notification
    * @type {"toast" | "inline"}
@@ -20,6 +15,10 @@
   export let caption = "Caption";
 </script>
 
+<!-- @component
+@deprecated This component is deprecated.
+-->
+
 {#if notificationType === "toast"}
   <div class:bx--toast-notification__details="{true}">
     <h3 class:bx--toast-notification__title="{true}">{title}</h3>
diff --git a/src/ToggleSmall/ToggleSmall.svelte b/src/ToggleSmall/ToggleSmall.svelte
index 7fcb64c5..29652e0e 100644
--- a/src/ToggleSmall/ToggleSmall.svelte
+++ b/src/ToggleSmall/ToggleSmall.svelte
@@ -1,10 +1,4 @@
 <script>
-  /**
-   * @deprecated
-   * This component will be removed in version 1.0.0.
-   * Use `<Toggle size="sm" />` instead
-   */
-
   /** Set to `true` to toggle the checkbox input */
   export let toggled = false;
 
@@ -30,6 +24,11 @@
   export let name = undefined;
 </script>
 
+<!-- @component
+@deprecated This component is deprecated.
+Use`<Toggle size="sm" />` instead.
+-->
+
 <!-- svelte-ignore a11y-mouse-events-have-key-events -->
 <div
   class:bx--form-item="{true}"
diff --git a/src/ToggleSmall/ToggleSmallSkeleton.svelte b/src/ToggleSmall/ToggleSmallSkeleton.svelte
index f4d73749..569b3deb 100644
--- a/src/ToggleSmall/ToggleSmallSkeleton.svelte
+++ b/src/ToggleSmall/ToggleSmallSkeleton.svelte
@@ -1,10 +1,4 @@
 <script>
-  /**
-   * @deprecated
-   * This component will be removed in version 1.0.0.
-   * Use `<ToggleSkeleton size="sm" />` instead
-   */
-
   /** Specify the label text */
   export let labelText = "";
 
@@ -12,6 +6,11 @@
   export let id = "ccs-" + Math.random().toString(36);
 </script>
 
+<!-- @component
+@deprecated This component is deprecated.
+Use`<ToggleSkeleton size="sm" />` instead.
+-->
+
 <!-- svelte-ignore a11y-mouse-events-have-key-events -->
 <div
   class:bx--form-item="{true}"
diff --git a/src/UIShell/GlobalHeader/HeaderActionSearch.svelte b/src/UIShell/GlobalHeader/HeaderActionSearch.svelte
index 5b40bd65..17e59f90 100644
--- a/src/UIShell/GlobalHeader/HeaderActionSearch.svelte
+++ b/src/UIShell/GlobalHeader/HeaderActionSearch.svelte
@@ -1,10 +1,4 @@
 <script>
-  /**
-   * @deprecated
-   * This component will be removed in version 1.0.0.
-   * Use `HeaderSearch` instead
-   */
-
   /**
    * @event {{ action: "search"; textInput: string; }} inputSearch
    */
@@ -64,6 +58,10 @@
   }}"
 />
 
+<!-- @component
+@deprecated
+This component is deprecated. Use `HeaderSearch` instead.
+-->
 <div
   bind:this="{elTypeSearch}"
   role="search"