docs(tsdoc): updated \@SInCE annotations

mlaursen · Feb 20, 2021 · c62027e · c62027e
1 parent 97bad8d
commit c62027e
Show file tree

Hide file tree

Showing 53 changed files with 178 additions and 178 deletions.
diff --git a/packages/autocomplete/src/types.ts b/packages/autocomplete/src/types.ts
@@ -295,7 +295,7 @@ export interface AutoCompleteProps
    * autocomplete's menu. This should normally be for any presentational data or
    * things that should not be searchable.
    *
-   * @since 2.1.0
+   * @remarks \@since 2.1.0
    */
   beforeResultsChildren?: ReactNode;
 
@@ -304,7 +304,7 @@ export interface AutoCompleteProps
    * autocomplete's menu. This should normally be for any presentational data or
    * things that should not be searchable.
    *
-   * @since 2.1.0
+   * @remarks \@since 2.1.0
    */
   afterResultsChildren?: ReactNode;
 }
diff --git a/packages/avatar/src/Avatar.tsx b/packages/avatar/src/Avatar.tsx
@@ -29,7 +29,7 @@ export interface AvatarProps extends HTMLAttributes<HTMLSpanElement> {
    *
    * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-referrerpolicy|Referrer Policy}
    *
-   * @since 2.2.0
+   * @remarks \@since 2.2.0
    */
   referrerPolicy?: ImgAttributes["referrerPolicy"];
 
@@ -42,7 +42,7 @@ export interface AvatarProps extends HTMLAttributes<HTMLSpanElement> {
    * Note: The values in this object will override the `src`, `alt`, and
    * `referrerPolicy` root level avatar props if they exist on this object.
    *
-   * @since 2.2.0
+   * @remarks \@since 2.2.0
    */
   imgProps?: PropsWithRef<ImgAttributes, HTMLImageElement>;
 

diff --git a/packages/chip/src/Chip.tsx b/packages/chip/src/Chip.tsx
@@ -107,7 +107,7 @@ export interface ChipProps extends ButtonAttributes {
    * Boolean if the chip should render as a non-interactable element (`<span>`)
    * instead of a button. This can be used to just apply the chip styles.
    *
-   * @since 2.6.0
+   * @remarks \@since 2.6.0
    */
   noninteractable?: boolean;
 }

diff --git a/packages/form/src/FormMessageContainer.tsx b/packages/form/src/FormMessageContainer.tsx
@@ -13,7 +13,7 @@ type MessageContainerProps = PropsWithRef<DivAttributes, HTMLDivElement>;
  * `FieldMessageContainer` component. This should really be used internally with
  * any `TextField` or `TextArea` related components.
  *
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export type FieldMessageContainerExtension<P> = P & {
   /**
@@ -34,7 +34,7 @@ export type FieldMessageContainerExtension<P> = P & {
 };
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export interface FormMessageContainerProps extends DivAttributes {
   /**
@@ -49,7 +49,7 @@ export interface FormMessageContainerProps extends DivAttributes {
  * A wrapper component that can be used to display a `TextField` related
  * component or `TextArea` along with the `FormMessage` component.
  *
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const FormMessageContainer = forwardRef<
   HTMLDivElement,

diff --git a/packages/form/src/label/Label.tsx b/packages/form/src/label/Label.tsx
@@ -4,7 +4,7 @@ import cn from "classnames";
 import { bem } from "@react-md/utils";
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export interface LabelStates {
   /**
@@ -51,7 +51,7 @@ const styles = bem("rmd-label");
  * shouldn't really be used, but it's useful if you want the label styles
  * without rendering a `<label>` element.
  *
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  * @internal
  */
 export const labelStyles = ({

diff --git a/packages/form/src/slider/RangeSlider.tsx b/packages/form/src/slider/RangeSlider.tsx
@@ -18,7 +18,7 @@ import { RangeSliderRequiredProps } from "./useRangeSlider";
 import { useSliderControls } from "./useSliderControls";
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export interface RangeSliderProps
   extends RangeSliderRequiredProps,
@@ -81,7 +81,7 @@ export interface RangeSliderProps
  * a predefined range of numbers. The functionality for controlling the value of
  * this component is provided by the `useRangeSlider` hook.
  *
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const RangeSlider = forwardRef<HTMLDivElement, RangeSliderProps>(
   function RangeSlider(

diff --git a/packages/form/src/slider/Slider.tsx b/packages/form/src/slider/Slider.tsx
@@ -13,7 +13,7 @@ import { SliderRequiredProps } from "./useSlider";
 import { useSliderControls } from "./useSliderControls";
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export interface SliderProps extends SliderRequiredProps, BaseSliderProps {
   /**
@@ -52,7 +52,7 @@ export interface SliderProps extends SliderRequiredProps, BaseSliderProps {
  * of numbers. The functionality for controlling the value of this component is
  * provided by the `useSlider` hook.
  *
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const Slider = forwardRef<HTMLDivElement, SliderProps>(function Slider(
   {

diff --git a/packages/form/src/slider/SliderContainer.tsx b/packages/form/src/slider/SliderContainer.tsx
@@ -9,7 +9,7 @@ import { labelStyles } from "../label";
 const styles = bem("rmd-slider-container");
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export interface SliderContainerProps
   extends HTMLAttributes<HTMLDivElement>,
@@ -36,7 +36,7 @@ export interface SliderContainerProps
  * left or right of the `SliderTrack`. When vertical, it will add addons to the
  * bottom or top instead.
  *
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const SliderContainer = forwardRef<HTMLDivElement, SliderContainerProps>(
   function SliderContainer(

diff --git a/packages/form/src/slider/SliderThumb.tsx b/packages/form/src/slider/SliderThumb.tsx
@@ -15,7 +15,7 @@ import { useDiscreteValueVisibility } from "./useDiscreteValueVisibility";
 const styles = bem("rmd-slider-thumb");
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export interface BaseThumbProps
   extends HTMLAttributes<HTMLSpanElement>,
@@ -61,15 +61,15 @@ export interface BaseThumbProps
 }
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export type SliderThumbProps = LabelRequiredForA11y<BaseThumbProps>;
 
 /**
  * The slider thumb implements the `role="slider"` for the `Slider` and
  * `RangeSlider` components.
  *
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const SliderThumb = forwardRef<HTMLSpanElement, SliderThumbProps>(
   function SliderThumb(

diff --git a/packages/form/src/slider/SliderTrack.tsx b/packages/form/src/slider/SliderTrack.tsx
@@ -13,7 +13,7 @@ type CSSProperties = React.CSSProperties & {
 };
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export interface SliderTrackProps
   extends HTMLAttributes<HTMLSpanElement>,
@@ -43,7 +43,7 @@ export interface SliderTrackProps
  * be dragged as well as a visual indication of the value. The main usage is to
  * update the custom css properties for the thumb's values.
  *
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const SliderTrack = forwardRef<HTMLSpanElement, SliderTrackProps>(
   function SliderTrack(

diff --git a/packages/form/src/slider/SliderValue.tsx b/packages/form/src/slider/SliderValue.tsx
@@ -23,7 +23,7 @@ const VERTICAL_CLASS_NAMES: CSSTransitionClassNames = {
 };
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  * @internal
  */
 export interface SliderValueProps extends TooltipProps {
@@ -37,7 +37,7 @@ export interface SliderValueProps extends TooltipProps {
  * This component creates the "discrete" slider thumb value by rendering a
  * tooltip when needed.
  *
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  * @internal
  */
 export function SliderValue({

diff --git a/packages/form/src/slider/constants.ts b/packages/form/src/slider/constants.ts
@@ -1,34 +1,34 @@
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const DEFAULT_SLIDER_GET_VALUE_TEXT = (): string => "";
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const DEFAULT_SLIDER_MIN = 0;
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const DEFAULT_SLIDER_MAX = 100;
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const DEFAULT_SLIDER_STEP = 1;
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const DEFAULT_SLIDER_ANIMATION_TIME = 150;
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const THUMB_1_VAR = "--offset1";
 
 /**
- * @since 2.5.0
+ * @remarks \@since 2.5.0
  */
 export const THUMB_2_VAR = "--offset2";