Fix tag type JSDOC when use multiple types | Fixes #736

liferay · Mar 14, 2018 · da68dc1 · da68dc1
1 parent 1e4caad
commit da68dc1
Show file tree

Hide file tree

Showing 35 changed files with 276 additions and 241 deletions.
diff --git a/packages/clay-alert/src/ClayAlert.js b/packages/clay-alert/src/ClayAlert.js
@@ -8,6 +8,7 @@ import templates from './ClayAlert.soy.js';
 
 /**
  * Metal Clay Alert component.
+ * @extends Component
  */
 class ClayAlert extends Component {
 	/**
@@ -64,7 +65,7 @@ ClayAlert.STATE = {
 	 * CSS classes to be applied to the element.
 	 * @instance
 	 * @memberof ClayAlert
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	elementClasses: Config.string(),
@@ -73,7 +74,7 @@ ClayAlert.STATE = {
 	 * Id to be applied to the element.
 	 * @instance
 	 * @memberof ClayAlert
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	id: Config.string(),
@@ -82,7 +83,7 @@ ClayAlert.STATE = {
 	 * The message of alert
 	 * @instance
 	 * @memberof ClayAlert
-	 * @type {!html|string}
+	 * @type {!(html|string)}
 	 */
 	message: Config.any().required(),
 

diff --git a/packages/clay-alert/src/ClayAlertBase.js b/packages/clay-alert/src/ClayAlertBase.js
@@ -10,6 +10,7 @@ import templates from './ClayAlertBase.soy.js';
 
 /**
  * Metal Clay Alert Base component.
+ * @extends Component
  */
 class ClayAlertBase extends Component {
 	/**
@@ -177,7 +178,7 @@ ClayAlertBase.STATE = {
 	 * CSS classes to be applied to the element.
 	 * @instance
 	 * @memberof ClayAlert
-	 * @type {?string|undefined}
+	 * @type {(?string|undefined)}
 	 * @default undefined
 	 */
 	elementClasses: Config.string(),
@@ -186,7 +187,7 @@ ClayAlertBase.STATE = {
 	 * Id to be applied to the element.
 	 * @instance
 	 * @memberof ClayAlert
-	 * @type {?string|undefined}
+	 * @type {(?string|undefined)}
 	 * @default undefined
 	 */
 	id: Config.string(),
@@ -195,7 +196,7 @@ ClayAlertBase.STATE = {
 	 * The message of alert
 	 * @instance
 	 * @memberof ClayAlertBase
-	 * @type {!html|string}
+	 * @type {!(html|string)}
 	 */
 	message: Config.any().required(),
 

diff --git a/packages/clay-alert/src/ClayStripe.js b/packages/clay-alert/src/ClayStripe.js
@@ -8,6 +8,7 @@ import templates from './ClayStripe.soy.js';
 
 /**
  * Metal Clay Stripe component.
+ * @extends Component
  */
 class ClayStripe extends Component {
 	/**
@@ -64,7 +65,7 @@ ClayStripe.STATE = {
 	 * CSS classes to be applied to the element.
 	 * @instance
 	 * @memberof ClayStripe
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	elementClasses: Config.string(),
@@ -73,7 +74,7 @@ ClayStripe.STATE = {
 	 * Id to be applied to the element.
 	 * @instance
 	 * @memberof ClayStripe
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	id: Config.string(),

diff --git a/packages/clay-alert/src/ClayToast.js b/packages/clay-alert/src/ClayToast.js
@@ -8,6 +8,7 @@ import templates from './ClayToast.soy.js';
 
 /**
  * Metal Clay Toast component.
+ * @extends Component
  */
 class ClayToast extends Component {
 	/**
@@ -64,7 +65,7 @@ ClayToast.STATE = {
 	 * CSS classes to be applied to the element.
 	 * @instance
 	 * @memberof ClayToast
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	elementClasses: Config.string(),
@@ -73,7 +74,7 @@ ClayToast.STATE = {
 	 * Id to be applied to the element.
 	 * @instance
 	 * @memberof ClayToast
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	id: Config.string(),
@@ -82,7 +83,7 @@ ClayToast.STATE = {
 	 * The message of alert
 	 * @instance
 	 * @memberof ClayToast
-	 * @type {!html|string}
+	 * @type {!(html|string)}
 	 */
 	message: Config.any().required(),
 

diff --git a/packages/clay-badge/src/ClayBadge.js b/packages/clay-badge/src/ClayBadge.js
@@ -7,6 +7,7 @@ import templates from './ClayBadge.soy.js';
 
 /**
  * Metal Clay Badge component.
+ * @extends Component
  */
 class ClayBadge extends Component {}
 
@@ -20,7 +21,7 @@ ClayBadge.STATE = {
 	 * CSS classes to be applied to the element.
 	 * @instance
 	 * @memberof ClayBadge
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	elementClasses: Config.string(),
@@ -29,8 +30,8 @@ ClayBadge.STATE = {
 	 * Id to be applied to the element.
 	 * @instance
 	 * @memberof ClayBadge
-	 * @type {?string|undefined}
-	 * default undefined
+	 * @type {?(string|undefined)}
+	 * @default undefined
 	 */
 	id: Config.string(),
 
@@ -39,7 +40,7 @@ ClayBadge.STATE = {
 	 * @instance
 	 * @memberof ClayBadge
 	 * @type {!string}
-	 * default undefined
+	 * @default undefined
 	 */
 	label: Config.string().required(),
 

diff --git a/packages/clay-button/src/ClayButton.js b/packages/clay-button/src/ClayButton.js
@@ -8,6 +8,7 @@ import templates from './ClayButton.soy.js';
 
 /**
  * Metal Clay Button component.
+ * @extends ClayComponent
  */
 class ClayButton extends ClayComponent {}
 
@@ -21,7 +22,7 @@ ClayButton.STATE = {
 	 * Aria label attribute for the button element.
 	 * @instance
 	 * @memberof ClayButton
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	ariaLabel: Config.string(),
@@ -57,7 +58,7 @@ ClayButton.STATE = {
 	 * CSS classes to be applied to the element.
 	 * @instance
 	 * @memberof ClayButton
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	elementClasses: Config.string(),
@@ -66,7 +67,7 @@ ClayButton.STATE = {
 	 * Icon to be rendered in the button.
 	 * @instance
 	 * @memberof ClayButton
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	icon: Config.string(),
@@ -84,7 +85,7 @@ ClayButton.STATE = {
 	 * Id to be applied to the element.
 	 * @instance
 	 * @memberof ClayButton
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	id: Config.string(),
@@ -93,7 +94,7 @@ ClayButton.STATE = {
 	 * The label of the button content.
 	 * @instance
 	 * @memberof ClayButton
-	 * @type {?html|string|undefined}
+	 * @type {?(html|string|undefined)}
 	 * @default undefined
 	 */
 	label: Config.any(),
@@ -111,7 +112,7 @@ ClayButton.STATE = {
 	 * The name attribute value of the element.
 	 * @instance
 	 * @memberof ClayButton
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	name: Config.string(),
@@ -121,7 +122,7 @@ ClayButton.STATE = {
 	 * button size.
 	 * @instance
 	 * @memberof ClayButton
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	size: Config.oneOf(['sm']),
@@ -130,7 +131,7 @@ ClayButton.STATE = {
 	 * The path to the SVG spritemap file containing the icons.
 	 * @instance
 	 * @memberof ClayButton
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	spritemap: Config.string(),
@@ -140,7 +141,7 @@ ClayButton.STATE = {
 	 * purposes.
 	 * @instance
 	 * @memberof ClayButton
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default primary
 	 */
 	style: Config.oneOf(['link', 'primary', 'secondary', 'unstyled']).value(
@@ -160,7 +161,7 @@ ClayButton.STATE = {
 	 * The value attribute value of the element.
 	 * @instance
 	 * @memberof ClayButton
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	value: Config.string(),

diff --git a/packages/clay-card-grid/src/ClayCardGrid.js b/packages/clay-card-grid/src/ClayCardGrid.js
@@ -16,6 +16,7 @@ import templates from './ClayCardGrid.soy.js';
 
 /**
  * Metal ClayCardGrid component.
+ * @extends Component
  */
 class ClayCardGrid extends Component {
 	/**
@@ -38,7 +39,7 @@ ClayCardGrid.STATE = {
 	 * CSS classes to be applied to the element.
 	 * @instance
 	 * @memberof ClayCardGrid
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	elementClasses: Config.string(),
@@ -47,7 +48,7 @@ ClayCardGrid.STATE = {
 	 * Id to be applied to the element.
 	 * @instance
 	 * @memberof ClayCardGrid
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	id: Config.string(),
@@ -56,7 +57,7 @@ ClayCardGrid.STATE = {
 	 * List of items.
 	 * @instance
 	 * @memberof ClayCardGrid
-	 * @type {?array|undefined}
+	 * @type {?(array|undefined)}
 	 * @default undefined
 	 */
 	items: Config.array(),
@@ -96,7 +97,7 @@ ClayCardGrid.STATE = {
 	 * The path to the SVG spritemap file containing the icons.
 	 * @instance
 	 * @memberof ClayCardGrid
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	spritemap: Config.string(),
@@ -105,7 +106,7 @@ ClayCardGrid.STATE = {
 	 * Header of the list group.
 	 * @instance
 	 * @memberof ClayCardGrid
-	 * @type {?string|undefined}
+	 * @type {?(string|undefined)}
 	 * @default undefined
 	 */
 	title: Config.string(),