Fixes JSDOC on ClayCharts | Fixes liferay#736

matuzalemsteles · Mar 15, 2018 · c7f1cf3 · c7f1cf3
1 parent fdd46b6
commit c7f1cf3
Show file tree

Hide file tree

Showing 16 changed files with 144 additions and 144 deletions.
diff --git a/packages/clay-charts/src/AreaLineChart.js b/packages/clay-charts/src/AreaLineChart.js
@@ -11,10 +11,10 @@ class AreaLineChart extends Chart {}
 AreaLineChart.STATE = {
 	/**
 	 * The variety of chart that will be rendered.
+	 * @default area
 	 * @instance
 	 * @memberof AreaLineChart
-	 * @type {?string|undefined}
-	 * @default area
+	 * @type {?(string|undefined)}
 	 */
 	type: Config.oneOf(types.area).value('area'),
 };

diff --git a/packages/clay-charts/src/AreaSplineChart.js b/packages/clay-charts/src/AreaSplineChart.js
@@ -11,10 +11,10 @@ class AreaSplineChart extends Chart {}
 AreaSplineChart.STATE = {
 	/**
 	 * The variety of chart that will be rendered.
+	 * @default area-spline
 	 * @instance
 	 * @memberof AreaSplineChart
-	 * @type {?string|undefined}
-	 * @default area-spline
+	 * @type {?(string|undefined)}
 	 */
 	type: Config.oneOf(types.area).value('area-spline'),
 };

diff --git a/packages/clay-charts/src/AreaStepChart.js b/packages/clay-charts/src/AreaStepChart.js
@@ -11,10 +11,10 @@ class AreaStepChart extends Chart {}
 AreaStepChart.STATE = {
 	/**
 	 * The variety of chart that will be rendered.
+	 * @default area
 	 * @instance
 	 * @memberof AreaStepChart
-	 * @type {?string|undefined}
-	 * @default area
+	 * @type {?(string|undefined)}
 	 */
 	type: Config.oneOf(types.area).value('area-step'),
 };

diff --git a/packages/clay-charts/src/BarChart.js b/packages/clay-charts/src/BarChart.js
@@ -11,10 +11,10 @@ class BarChart extends Chart {}
 BarChart.STATE = {
 	/**
 	 * The variety of chart that will be rendered.
+	 * @default bar
 	 * @instance
 	 * @memberof BarChart
-	 * @type {?string|undefined}
-	 * @default bar
+	 * @type {?(string|undefined)}
 	 */
 	type: Config.oneOf(types.point).value('bar'),
 };

diff --git a/packages/clay-charts/src/BubbleChart.js b/packages/clay-charts/src/BubbleChart.js
@@ -10,19 +10,19 @@ class BubbleChart extends Chart {}
 BubbleChart.STATE = {
 	/**
 	 * Labels visibility
+	 * @default true
 	 * @instance
 	 * @memberof BubbleChart
 	 * @type {Boolean}
-	 * @default true
 	 */
 	labels: Config.bool().value(true),
 
 	/**
 	 * The variety of chart that will be rendered.
+	 * @default donut
 	 * @instance
 	 * @memberof DonutChart
-	 * @type {?string|undefined}
-	 * @default donut
+	 * @type {?(string|undefined)}
 	 */
 	type: Config.string().value('bubble'),
 };

diff --git a/packages/clay-charts/src/Chart.js b/packages/clay-charts/src/Chart.js
@@ -5,8 +5,8 @@ import templates from './Chart.soy.js';
 
 /**
  * Metal Chart component.
- * @extends Component
  * @extends ChartBase
+ * @extends Component
  */
 class Chart extends DataComponent {}