docs: update JSDoc comments

Author: mrholek

src/components/accordion/CAccordion.tsx

@@ -4,19 +4,19 @@ import classNames from 'classnames'
 
 export interface CAccordionProps extends HTMLAttributes<HTMLDivElement> {
   /**
-   * The active item key. [docs]
+   * The active item key.
    */
   activeItemKey?: number | string
   /**
    * Make accordion items stay open when another item is opened
    */
   alwaysOpen?: boolean
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
   /**
-   * Removes the default background-color, some borders, and some rounded corners to render accordions edge-to-edge with their parent container. [docs]
+   * Removes the default background-color, some borders, and some rounded corners to render accordions edge-to-edge with their parent container.
    */
   flush?: boolean
 }

src/components/accordion/CAccordionBody.tsx

@@ -7,7 +7,7 @@ import { CAccordionItemContext } from './CAccordionItem'
 import { CCollapse } from './../collapse/CCollapse'
 export interface CAccordionBodyProps extends HTMLAttributes<HTMLDivElement> {
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
 }

src/components/accordion/CAccordionButton.tsx

@@ -6,7 +6,7 @@ import { CAccordionItemContext } from './CAccordionItem'
 
 export interface CAccordionButtonProps extends HTMLAttributes<HTMLButtonElement> {
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
 }

src/components/accordion/CAccordionHeader.tsx

@@ -6,7 +6,7 @@ import { CAccordionButton } from './CAccordionButton'
 
 export interface CAccordionHeaderProps extends HTMLAttributes<HTMLDivElement> {
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
 }

src/components/accordion/CAccordionItem.tsx

@@ -21,11 +21,11 @@ export const CAccordionItemContext = createContext({} as CAccordionItemContextPr
 
 export interface CAccordionItemProps extends HTMLAttributes<HTMLDivElement> {
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
   /**
-   * Item key. [docs]
+   * Item key.
    */
   itemKey?: number | string
 }

src/components/alert/CAlert.tsx

@@ -8,36 +8,33 @@ import { CCloseButton } from '../close-button/CCloseButton'
 
 export interface CAlertProps extends HTMLAttributes<HTMLDivElement> {
   /**
-   * A string of all className you want applied to the component. [docs]
+   * A string of all className you want applied to the component.
    */
   className?: string
   /**
-   * Sets the color context of the component to one of CoreUI’s themed colors. [docs]
+   * Sets the color context of the component to one of CoreUI’s themed colors.
    *
-   * @type {'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string }
-   * @default 'primary'
+   * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string
    */
   color: Colors
   /**
-   * Optionally add a close button to alert and allow it to self dismiss. [docs]
+   * Optionally add a close button to alert and allow it to self dismiss.
    */
   dismissible?: boolean
   /**
-   * Method called before the dissmiss animation has started. [docs]
+   * Method called before the dissmiss animation has started.
    */
   onDismiss?: () => void
   /**
-   * Method called after the dissmiss animation has completed and the component is removed from the dom. [docs]
+   * Method called after the dissmiss animation has completed and the component is removed from the dom.
    */
   onDismissed?: () => void
   /**
-   * Set the alert variant to a solid. [docs]
+   * Set the alert variant to a solid.
    */
   variant?: 'solid' | string
   /**
-   * Toggle the visibility of component. [docs]
-   *
-   * @default true
+   * Toggle the visibility of component.
    */
   visible?: boolean
 }

src/components/alert/CAlertHeading.tsx

@@ -4,13 +4,11 @@ import classNames from 'classnames'
 
 export interface CAlertHeadingProps extends HTMLAttributes<HTMLHeadingElement> {
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
   /**
-   * Component used for the root node. Either a string to use a HTML element or a component. [docs]
-   *
-   * @default 'h4'
+   * Component used for the root node. Either a string to use a HTML element or a component.
    */
   component?: string | ElementType
 }

src/components/alert/CAlertLink.tsx

@@ -6,7 +6,7 @@ import { CLink } from '../link/CLink'
 
 export interface CAlertLinkProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
 }

src/components/avatar/CAvatar.tsx

@@ -13,39 +13,39 @@ import {
 
 export interface CAvatarProps extends HTMLAttributes<HTMLDivElement> {
   /**
-   * A string of all className you want applied to the component. [docs]
+   * A string of all className you want applied to the component.
    */
   className?: string
   /**
-   * Sets the color context of the component to one of CoreUI’s themed colors. [docs]
+   * Sets the color context of the component to one of CoreUI’s themed colors.
    *
-   * @type {'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string}
+   * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string
    */
   color?: Colors
   /**
-   * Select the shape of the component. [docs]
+   * Select the shape of the component.
    *
-   * @type {'rounded' | 'rounded-top' | 'rounded-end' | 'rounded-bottom' | 'rounded-start' | 'rounded-circle' | 'rounded-pill' | 'rounded-0' | 'rounded-1' | 'rounded-2' | 'rounded-3' | string}
+   * @type 'rounded' | 'rounded-top' | 'rounded-end' | 'rounded-bottom' | 'rounded-start' | 'rounded-circle' | 'rounded-pill' | 'rounded-0' | 'rounded-1' | 'rounded-2' | 'rounded-3' | string
    */
   shape?: Shapes
   /**
-   * Size the component small, large, or extra large. [docs]
+   * Size the component small, large, or extra large.
    */
   size?: string
   /**
-   * The src attribute for the img element. [docs]
+   * The src attribute for the img element.
    */
   src?: string
   /**
-   * Sets the color context of the status indicator to one of CoreUI’s themed colors. [docs]
+   * Sets the color context of the status indicator to one of CoreUI’s themed colors.
    *
-   * @type {'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string}
+   * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string
    */
   status?: Colors
   /**
-   * Sets the text color of the component to one of CoreUI’s themed colors. [docs]
+   * Sets the text color of the component to one of CoreUI’s themed colors.
    *
-   * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | 'white' | 'muted' | string
+   * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | 'white' | 'muted' | 'high-emphasis' | 'medium-emphasis' | 'disabled' | 'high-emphasis-inverse' | 'medium-emphasis-inverse' | 'disabled-inverse' | string
    */
   textColor?: TextColors
 }

src/components/backdrop/CBackdrop.tsx

@@ -5,11 +5,11 @@ import classNames from 'classnames'
 
 export interface CBackdropProps extends HTMLAttributes<HTMLDivElement> {
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
   /**
-   * Toggle the visibility of modal component. [docs]
+   * Toggle the visibility of modal component.
    */
   visible?: boolean
 }

src/components/badge/CBadge.tsx

@@ -13,43 +13,37 @@ import {
 
 export interface CBadgeProps extends HTMLAttributes<HTMLDivElement | HTMLSpanElement> {
   /**
-   * A string of all className you want applied to the component. [docs]
+   * A string of all className you want applied to the component.
    */
   className?: string
   /**
-   * Sets the color context of the component to one of CoreUI’s themed colors. [docs]
+   * Sets the color context of the component to one of CoreUI’s themed colors.
    *
-   * @type {'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string}
+   * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string
    */
   color?: Colors
   /**
-   * Component used for the root node. Either a string to use a HTML element or a component. [docs]
-   *
-   * @default 'span'
+   * Component used for the root node. Either a string to use a HTML element or a component.
    */
   component?: string | ElementType
   /**
    * Position badge in one of the corners of a link or button.
-   *
-   * @type 'top-start' | 'top-end' | 'bottom-end' | 'bottom-start'
    */
   position?: 'top-start' | 'top-end' | 'bottom-end' | 'bottom-start'
   /**
-   * Select the shape of the component. [docs]
+   * Select the shape of the component.
    *
    * @type 'rounded' | 'rounded-top' | 'rounded-end' | 'rounded-bottom' | 'rounded-start' | 'rounded-circle' | 'rounded-pill' | 'rounded-0' | 'rounded-1' | 'rounded-2' | 'rounded-3' | string
    */
   shape?: Shapes
   /**
-   * Size the component small. [docs]
-   *
-   * @type 'sm'
+   * Size the component small.
    */
   size?: 'sm'
   /**
-   * Sets the text color of the component to one of CoreUI’s themed colors. [docs]
+   * Sets the text color of the component to one of CoreUI’s themed colors.
    *
-   * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | 'white' | 'muted' | string
+   * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | 'white' | 'muted' | 'high-emphasis' | 'medium-emphasis' | 'disabled' | 'high-emphasis-inverse' | 'medium-emphasis-inverse' | 'disabled-inverse' | string
    */
   textColor?: TextColors
 }

src/components/breadcrumb/CBreadcrumb.tsx

@@ -4,7 +4,7 @@ import classNames from 'classnames'
 
 export interface CBreadcrumbProps extends HTMLAttributes<HTMLOListElement> {
   /**
-   * A string of all className you want applied to the component. [docs]
+   * A string of all className you want applied to the component.
    */
   className?: string
 }

src/components/breadcrumb/CBreadcrumbItem.tsx

@@ -6,15 +6,15 @@ import { CLink } from '../link/CLink'
 
 export interface CBreadcrumbItemProps extends HTMLAttributes<HTMLLIElement> {
   /**
-   * Toggle the active state for the component. [docs]
+   * Toggle the active state for the component.
    */
   active?: boolean
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
   /**
-   * The `href` attribute for the inner `<CLink>` component. [docs]
+   * The `href` attribute for the inner `<CLink>` component.
    */
   href?: string
 }

src/components/button-group/CButtonGroup.tsx

@@ -4,17 +4,15 @@ import classNames from 'classnames'
 
 export interface CButtonGroupProps extends HTMLAttributes<HTMLDivElement> {
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
   /**
-   * Size the component small or large. [docs]
-   *
-   * @type {'sm' | 'lg'}
+   * Size the component small or large.
    */
   size?: 'sm' | 'lg'
   /**
-   * Create a set of buttons that appear vertically stacked rather than horizontally. Split button dropdowns are not supported here. [docs]
+   * Create a set of buttons that appear vertically stacked rather than horizontally. Split button dropdowns are not supported here.
    */
   vertical?: boolean
 }

src/components/button-group/CButtonToolbar.tsx

@@ -4,7 +4,7 @@ import classNames from 'classnames'
 
 export interface CButtonToolbarProps extends HTMLAttributes<HTMLDivElement> {
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
 }

src/components/button/CButton.tsx

@@ -7,56 +7,52 @@ import { CLink } from '../link/CLink'
 
 export interface CButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
   /**
-   * Toggle the active state for the component. [docs]
+   * Toggle the active state for the component.
    */
   active?: boolean
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
   /**
-   * Sets the color context of the component to one of CoreUI’s themed colors. [docs]
+   * Sets the color context of the component to one of CoreUI’s themed colors.
    *
    * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string
    */
   color?: Colors
   /**
-   * Component used for the root node. Either a string to use a HTML element or a component. [docs]
+   * Component used for the root node. Either a string to use a HTML element or a component.
    */
   component?: string | ElementType
   /**
-   * Toggle the disabled state for the component. [docs]
+   * Toggle the disabled state for the component.
    */
   disabled?: boolean
   /**
-   * The href attribute specifies the URL of the page the link goes to. [docs]
+   * The href attribute specifies the URL of the page the link goes to.
    */
   href?: string
   /**
-   * The role attribute describes the role of an element in programs that can make use of it, such as screen readers or magnifiers. [docs]
+   * The role attribute describes the role of an element in programs that can make use of it, such as screen readers or magnifiers.
    */
   role?: string
   /**
-   * Select the shape of the component. [docs]
+   * Select the shape of the component.
    *
    * @type 'rounded' | 'rounded-top' | 'rounded-end' | 'rounded-bottom' | 'rounded-start' | 'rounded-circle' | 'rounded-pill' | 'rounded-0' | 'rounded-1' | 'rounded-2' | 'rounded-3' | string
    */
   shape?: Shapes
   /**
-   * Size the component small or large. [docs]
-   *
-   * @type 'sm' | 'lg'
+   * Size the component small or large.
    */
   size?: 'sm' | 'lg'
   /**
    * Specifies the type of button. Always specify the type attribute for the `<button>` element.
-   * Different browsers may use different default types for the `<button>` element. [docs]
-   *
-   * @type 'button' | 'submit' | 'reset'
+   * Different browsers may use different default types for the `<button>` element.
    */
   type?: 'button' | 'submit' | 'reset'
   /**
-   * Set the button variant to an outlined button or a ghost button. [docs]
+   * Set the button variant to an outlined button or a ghost button.
    */
   variant?: 'outline' | 'ghost'
 }

src/components/callout/CCallout.tsx

@@ -6,13 +6,13 @@ import { Colors, colorPropType } from '../Types'
 
 export interface CCalloutProps extends HTMLAttributes<HTMLDivElement> {
   /**
-   * A string of all className you want applied to the base component. [docs]
+   * A string of all className you want applied to the base component.
    */
   className?: string
   /**
-   * Sets the color context of the component to one of CoreUI’s themed colors. [docs]
+   * Sets the color context of the component to one of CoreUI’s themed colors.
    *
-   * @type {'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string}
+   * @type 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light' | string
    */
   color?: Colors
 }