docs(tsdoc): fixed remaining tsdoc syntax warnings

Author: mlaursen

packages/alert/src/MessageQueue.tsx

@@ -25,15 +25,15 @@ export interface MessageQueueProps<M extends ToastMessage>
 
   /**
    * An optional function to call when the action button is clicked. This will
-   * be applied to **all** toasts that appear in this message queue. You will be
-   * provided the current message followed by the click event.
+   * be applied to **all** toasts that appear in this message queue. You will
+   * be provided the current message followed by the click event.
    */
   onActionClick?: ActionEventHandler<M>;
 }
 
 /**
- * This component is used to be able to create a queue of messages with the `Snackbar` and
- * `Toast` components with a _fairly_ decent API out of the box.
+ * This component is used to be able to create a queue of messages with the
+ * `Snackbar` and `Toast` components with a _fairly_ decent API out of the box.
  */
 export function MessageQueue<M extends ToastMessage = ToastMessage>({
   timeout = 5000,

packages/alert/src/scssVariables.ts

@@ -1,4 +1,4 @@
-/**
+/*
  * This file was generated from @react-md/dev-utils and should not be updated
  * manually.
  */

packages/alert/src/useMessageQueue.ts

@@ -69,8 +69,8 @@ export type MessageActions<M extends Message = ToastMessage> =
   | ResetQueueAction;
 
 /**
- * This function is used to update the message queue state by adding a new message when
- * needed.
+ * This function is used to update the message queue state by adding a new
+ * message when needed.
  *
  * @internal
  */
@@ -94,8 +94,8 @@ export function handleAddMessage<M extends Message = ToastMessage>(
   if (isNext || isImmediate) {
     const nextState = state.slice();
 
-    // remove the existing message if duplicated messages aren't allowed. This will
-    // kind of act like a replace + next behavior
+    // remove the existing message if duplicated messages aren't allowed. This
+    // will kind of act like a replace + next behavior
     if (!isDuplicable && i > 0) {
       nextState.splice(i, 1);
     }
@@ -114,8 +114,8 @@ export function handleAddMessage<M extends Message = ToastMessage>(
 
   if (isNormal) {
     if (isRestart) {
-      // creating a new state so that the queue visibility hook can still be triggered
-      // which will restart the timer
+      // creating a new state so that the queue visibility hook can still be
+      // triggered which will restart the timer
       return state.slice();
     }
 
@@ -171,7 +171,8 @@ export interface MessageQueueResult<M extends Message = ToastMessage>
 /**
  * This is the main logic for the message queue behavior that will handle:
  *
- * - creating timeouts as needed to show/hide toasts within the SnackbarQueue component
+ * - creating timeouts as needed to show/hide toasts within the `SnackbarQueue`
+ *   component
  * - create a way to push messages with optional priority onto the queue
  *
  * @internal
@@ -217,8 +218,8 @@ export function useMessageQueue<M extends Message = ToastMessage>({
   );
 
   useEffect(() => {
-    // this effect will handle all the "logic" for transitioning between each message along with the
-    // message priority updates.
+    // this effect will handle all the "logic" for transitioning between each
+    // message along with the message priority updates.
     const [message, nextMessage] = queue;
     if (!message) {
       return;

packages/app-bar/src/scssVariables.ts

@@ -1,4 +1,4 @@
-/**
+/*
  * This file was generated from @react-md/dev-utils and should not be updated
  * manually.
  */

packages/avatar/src/scssVariables.ts

@@ -1,4 +1,4 @@
-/**
+/*
  * This file was generated from @react-md/dev-utils and should not be updated
  * manually.
  */

packages/badge/src/scssVariables.ts

@@ -1,4 +1,4 @@
-/**
+/*
  * This file was generated from @react-md/dev-utils and should not be updated
  * manually.
  */

packages/button/src/scssVariables.ts

@@ -1,4 +1,4 @@
-/**
+/*
  * This file was generated from @react-md/dev-utils and should not be updated
  * manually.
  */

packages/card/src/scssVariables.ts

@@ -1,4 +1,4 @@
-/**
+/*
  * This file was generated from @react-md/dev-utils and should not be updated
  * manually.
  */

packages/chip/src/scssVariables.ts

@@ -1,4 +1,4 @@
-/**
+/*
  * This file was generated from @react-md/dev-utils and should not be updated
  * manually.
  */

packages/dev-utils/@types/sassdoc.d.ts

@@ -1,13 +1,19 @@
 /**
  * From the sassdoc documentation:
  *
- * > sassdoc uses the word "item" to described either a variable, a function, a
- * > mixin, or a placeholder.
+ * @remarks
+ *
+ * sassdoc uses the word "item" to described either a variable, a function, a
+ * mixin, or a placeholder.
+ *
+ *
+ * @remarks
  *
  * The types will be named and based off of this documentation.
  *
  * Note: I should probably move this to the DefinitelyTyped repo at some point.
- * @see http://sassdoc.com/data-interface/#terminology
+ *
+ * @see {@link http://sassdoc.com/data-interface/#terminology|SassDoc Data Interface}
  */
 declare module "sassdoc" {
   /**
@@ -556,7 +562,7 @@ declare module "sassdoc" {
     throw?: ItemThrow;
 
     /**
-     * An optional @since annotation that has a version number and an optional
+     * An optional `@since` annotation that has a version number and an optional
      * description.
      */
     since?: ItemSince[];