fix(tables): moves deprecation comments to component definitions (#1743)

Author: geotrev

packages/tables/src/elements/Body.tsx

@@ -9,6 +9,8 @@ import React, { HTMLAttributes, forwardRef } from 'react';
 import { StyledBody } from '../styled';
 
 /**
+ * @deprecated use `Table.Body` instead
+ *
  * @extends HTMLAttributes<HTMLTableSectionElement>
  */
 export const Body = forwardRef<HTMLTableSectionElement, HTMLAttributes<HTMLTableSectionElement>>(

packages/tables/src/elements/Caption.tsx

@@ -9,6 +9,8 @@ import React, { HTMLAttributes, forwardRef } from 'react';
 import { StyledCaption } from '../styled';
 
 /**
+ * @deprecated use `Table.Caption` instead
+ *
  * @extends HTMLAttributes<HTMLTableCaptionElement>
  */
 export const Caption = forwardRef<HTMLTableCaptionElement, HTMLAttributes<HTMLTableCaptionElement>>(

packages/tables/src/elements/Cell.tsx

@@ -12,6 +12,8 @@ import { useTableContext } from '../utils/useTableContext';
 import { ICellProps } from '../types';
 
 /**
+ * @deprecated use `Table.Cell` instead
+ *
  * @extends TdHTMLAttributes<HTMLTableCellElement>
  */
 export const Cell = React.forwardRef<HTMLTableCellElement, ICellProps>(

packages/tables/src/elements/GroupRow.tsx

@@ -10,6 +10,8 @@ import { StyledGroupRow } from '../styled';
 import { useTableContext } from '../utils/useTableContext';
 
 /**
+ * @deprecated use `Table.GroupRow` instead
+ *
  * @extends HTMLAttributes<HTMLTableRowElement>
  */
 export const GroupRow = forwardRef<HTMLTableRowElement, HTMLAttributes<HTMLTableRowElement>>(

packages/tables/src/elements/Head.tsx

@@ -10,6 +10,8 @@ import { StyledHead } from '../styled';
 import { IHeadProps } from '../types';
 
 /**
+ * @deprecated use `Table.Head` instead
+ *
  * @extends HTMLAttributes<HTMLTableSectionElement>
  */
 export const Head = forwardRef<HTMLTableSectionElement, IHeadProps>((props, ref) => (

packages/tables/src/elements/HeaderCell.tsx

@@ -12,6 +12,8 @@ import { useTableContext } from '../utils/useTableContext';
 import { Cell } from './Cell';
 
 /**
+ * @deprecated use `Table.HeaderCell` instead
+ *
  * @extends ThHTMLAttributes<HTMLTableCellElement>
  */
 export const HeaderCell = forwardRef<HTMLTableCellElement, IHeaderCellProps>(

packages/tables/src/elements/HeaderRow.tsx

@@ -10,6 +10,8 @@ import { StyledHeaderRow } from '../styled';
 import { useTableContext } from '../utils/useTableContext';
 
 /**
+ * @deprecated use `Table.HeaderRow` instead
+ *
  * @extends HTMLAttributes<HTMLTableRowElement>
  */
 export const HeaderRow = React.forwardRef<HTMLTableRowElement, HTMLAttributes<HTMLTableRowElement>>(

packages/tables/src/elements/OverflowButton.tsx

@@ -22,6 +22,8 @@ export interface IOverflowButtonProps extends ButtonHTMLAttributes<HTMLButtonEle
 }
 
 /**
+ * @deprecated use `Table.OverflowButton` instead
+ *
  * @extends ButtonHTMLAttributes<HTMLButtonElement>
  */
 export const OverflowButton = forwardRef<HTMLButtonElement, IOverflowButtonProps>(

packages/tables/src/elements/Row.tsx

@@ -13,6 +13,8 @@ import { StyledRow } from '../styled';
 import { useTableContext } from '../utils/useTableContext';
 
 /**
+ * @deprecated use `Table.Row` instead
+ *
  * @extends HTMLAttributes<HTMLTableRowElement>
  */
 

packages/tables/src/elements/SortableCell.tsx

@@ -18,6 +18,8 @@ import {
 } from '../styled';
 
 /**
+ * @deprecated use `Table.SortableCell` instead
+ *
  * @extends ButtonHTMLAttributes<HTMLButtonElement>
  */
 export const SortableCell = forwardRef<HTMLButtonElement, ISortableCellProps>(