Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/contributing/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Almost all documentation for Enact is generated directly from the source code or

## Documentation Overview

In-line documentation uses standard [jsDoc tags](http://usejsdoc.org/) with some additional Enact-specific tags. In-line documentation appears within comment blocks that begin with double asterisks:
In-line documentation uses standard [jsDoc tags](https://jsdoc.app) with some additional Enact-specific tags. In-line documentation appears within comment blocks that begin with double asterisks:

```js
/**
Expand Down Expand Up @@ -63,7 +63,7 @@ Below is an example block for a component:
*
* @class LabeledIcon
* @memberof ui/LabeledIcon
* @extends ui/LabeledIcon.LabeledIconBase
* @extends ui/LabeledIcon#LabeledIconBase
* @mixes ui/LabeledIcon.LabeledIconDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/BodyText/BodyText.js
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ const BodyTextDecorator = ForwardRef({prop: 'componentRef'});
*
* @class BodyText
* @memberof ui/BodyText
* @extends ui/BodyText.BodyTextBase
* @extends ui/BodyText#BodyTextBase
* @mixes ui/BodyText.BodyTextDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Button/Button.js
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ const ButtonDecorator = compose(
*
* @class Button
* @memberof ui/Button
* @extends ui/Button.ButtonBase
* @extends ui/Button#ButtonBase
* @mixes ui/Button.ButtonDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/FloatingLayer/FloatingLayer.js
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ const handleCancel = handle(
* @class FloatingLayer
* @memberof ui/FloatingLayer
* @ui
* @extends ui/FloatingLayer.FloatingLayerBase
* @extends ui/FloatingLayer#FloatingLayerBase
* @mixes ui/Cancelable.Cancelable
* @public
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Group/Group.js
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ const GroupDecorator = compose(
*
* @class Group
* @memberof ui/Group
* @extends ui/Group.GroupBase
* @extends ui/Group#GroupBase
* @mixes ui/Group.GroupDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Heading/Heading.js
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ const HeadingDecorator = compose(
*
* @class Heading
* @memberof ui/Heading
* @extends ui/Heading.HeadingBase
* @extends ui/Heading#HeadingBase
* @mixes ui/Heading.HeadingDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Icon/Icon.js
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ const IconDecorator = compose(
* An Icon component.
*
* @class Icon
* @extends ui/Icon.IconBase
* @extends ui/Icon#IconBase
* @mixes ui/Icon.IconDecorator
* @omit componentRef
* @memberof ui/Icon
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/IconButton/IconButton.js
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ const IconButtonDecorator = compose(
* ```
*
* @class IconButton
* @extends ui/IconButton.IconButtonBase
* @extends ui/IconButton#IconButtonBase
* @mixes ui/IconButton.IconButtonDecorator
* @omit componentRef
* @memberof ui/IconButton
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Image/Image.js
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ const ImageDecorator = compose(
*
* @class Image
* @memberof ui/Image
* @extends ui/Image.ImageBase
* @extends ui/Image#ImageBase
* @mixes ui/Image.ImageDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/ImageItem/ImageItem.js
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ const ImageItemDecorator = compose(
*
* @class ImageItem
* @memberof ui/ImageItem
* @extends ui/ImageItem.ImageItemBase
* @extends ui/ImageItem#ImageItemBase
* @mixes ui/ImageItem.ImageItemDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Item/Item.js
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ const ItemDecorator = compose(
*
* @class Item
* @memberof ui/Item
* @extends ui/Item.ItemBase
* @extends ui/Item#ItemBase
* @mixes ui/Item.ItemDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/LabeledIcon/LabeledIcon.js
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ const LabeledIconDecorator = compose(
*
* @class LabeledIcon
* @memberof ui/LabeledIcon
* @extends ui/LabeledIcon.LabeledIconBase
* @extends ui/LabeledIcon#LabeledIconBase
* @mixes ui/LabeledIcon.LabeledIconDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Layout/Cell.js
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ const CellDecorator = ForwardRef({prop: 'componentRef'});
*
* @class Cell
* @memberof ui/Layout
* @extends ui/Layout.CellBase
* @extends ui/Layout#CellBase
* @mixes ui/Layout.CellDecorator
* @omit componentRef
* @ui
Expand Down
6 changes: 3 additions & 3 deletions packages/ui/Layout/Layout.js
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ const LayoutDecorator = ForwardRef({prop: 'componentRef'});
*
* @class Layout
* @memberof ui/Layout
* @extends ui/Layout.LayoutBase
* @extends ui/Layout#LayoutBase
* @mixes ui/ForwardRef.ForwardRef
* @omit componentRef
* @ui
Expand All @@ -357,7 +357,7 @@ const Layout = LayoutDecorator(LayoutBase);
*
* @class Column
* @memberof ui/Layout
* @extends ui/Layout.Layout
* @extends ui/Layout#Layout
* @mixes ui/ForwardRef.ForwardRef
* @ui
* @public
Expand All @@ -381,7 +381,7 @@ Column.displayName = 'Column';
*
* @class Row
* @memberof ui/Layout
* @extends ui/Layout.Layout
* @extends ui/Layout#Layout
* @mixes ui/ForwardRef.ForwardRef
* @ui
* @public
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Marquee/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import MarqueeDecorator from './MarqueeDecorator';
* A minimally-styled marquee component.
*
* @class Marquee
* @extends ui/Marquee.MarqueeBase
* @extends ui/Marquee#MarqueeBase
* @memberof ui/Marquee
* @mixes ui/Marquee.MarqueeDecorator
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/ProgressBar/ProgressBar.js
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ const ProgressBarDecorator = compose(
*
* @class ProgressBar
* @memberof ui/ProgressBar
* @extends ui/ProgressBar.ProgressBarBase
* @extends ui/ProgressBar#ProgressBarBase
* @mixes ui/ProgressBar.ProgressBarDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Repeater/Repeater.js
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ const RepeaterDecorator = ForwardRef({prop: 'componentRef'});
*
* @class Repeater
* @memberof ui/Repeater
* @extends ui/Repeater.RepeaterBase
* @extends ui/Repeater#RepeaterBase
* @mixes ui/Repeater.RepeaterDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Routable/Link.js
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ const Linkable = hoc({navigate: 'onClick'}, (config, Wrapped) => {
*
* @class Link
* @ui
* @extends ui/Routable.LinkBase
* @extends ui/Routable#LinkBase
* @mixes ui/Routable.Linkable
* @memberof ui/Routable
* @public
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Scrollable/Scrollable.js
Original file line number Diff line number Diff line change
Expand Up @@ -1389,7 +1389,7 @@ class ScrollableBase extends Component {
*
* @class Scrollable
* @memberof ui/Scrollable
* @extends ui/Scrollable.ScrollableBase
* @extends ui/Scrollable#ScrollableBase
* @ui
* @private
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Scrollable/ScrollableNative.js
Original file line number Diff line number Diff line change
Expand Up @@ -1393,7 +1393,7 @@ class ScrollableBaseNative extends Component {
*
* @class ScrollableNative
* @memberof ui/ScrollableNative
* @extends ui/Scrollable.ScrollableBaseNative
* @extends ui/Scrollable#ScrollableBaseNative
* @ui
* @private
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Scroller/Scroller.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ const nop = () => {};
*
* @class Scroller
* @memberof ui/Scroller
* @extends ui/Scroller.ScrollerBasic
* @extends ui/Scroller#ScrollerBasic
* @ui
* @public
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Slider/Slider.js
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ const SliderDecorator = compose(
* A minimally-styled slider component with touch and drag support.
*
* @class Slider
* @extends ui/Slider.SliderBase
* @extends ui/Slider#SliderBase
* @memberof ui/Slider
* @mixes ui/Slider.SliderDecorator
* @omit componentRef
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/SlotItem/SlotItem.js
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ const SlotItemDecorator = compose(
*
* @class SlotItem
* @memberof ui/SlotItem
* @extends ui/SlotItem.SlotItemBase
* @extends ui/SlotItem#SlotItemBase
* @mixes ui/SlotItem.SlotItemDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/Spinner/Spinner.js
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ const SpinnerDecorator = ForwardRef({prop: 'componentRef'});
*
* @class Spinner
* @memberof ui/Spinner
* @extends ui/Spinner.SpinnerBase
* @extends ui/Spinner#SpinnerBase
* @mixes ui/Spinner.SpinnerDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/ToggleIcon/ToggleIcon.js
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ const ToggleIconDecorator = compose(
*
* @class ToggleIcon
* @memberof ui/ToggleIcon
* @extends ui/ToggleIcon.ToggleIconBase
* @extends ui/ToggleIcon#ToggleIconBase
* @mixes ui/ToggleIcon.ToggleIconDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/ToggleItem/ToggleItem.js
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ const ToggleItemDecorator = compose(
*
* @class ToggleItem
* @memberof ui/ToggleItem
* @extends ui/ToggleItem.ToggleItemBase
* @extends ui/ToggleItem#ToggleItemBase
* @mixes ui/ToggleItem.ToggleItemDecorator
* @omit componentRef
* @ui
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/ViewManager/ViewManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ const ViewManagerDecorator = ForwardRef({prop: 'componentRef'});
*
* @class ViewManager
* @memberof ui/ViewManager
* @extends ui/ViewManager.ViewManagerBase
* @extends ui/ViewManager#ViewManagerBase
* @mixes ui/ViewManager.ViewManagerDecorator
* @omit componentRef
* @ui
Expand Down
4 changes: 2 additions & 2 deletions packages/ui/VirtualList/VirtualList.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const nop = () => {};
*
* @class VirtualList
* @memberof ui/VirtualList
* @extends ui/VirtualList.VirtualListBasic
* @extends ui/VirtualList#VirtualListBasic
* @ui
* @public
*/
Expand Down Expand Up @@ -300,7 +300,7 @@ VirtualList.defaultProps = {
*
* @class VirtualGridList
* @memberof ui/VirtualList
* @extends ui/VirtualList.VirtualListBasic
* @extends ui/VirtualList#VirtualListBasic
* @ui
* @public
*/
Expand Down