API Doc changes to Graphics and Charts. Fixes #2528390

mchiocca · Aug 11, 2011 · 0fdefaa · 0fdefaa
1 parent d198595
commit 0fdefaa
Show file tree

Hide file tree

Showing 29 changed files with 827 additions and 79 deletions.
diff --git a/src/charts/docs/index.mustache b/src/charts/docs/index.mustache
@@ -1,7 +1,7 @@
 <div class="intro">
 	<p>
 		<img src="{{componentAssets}}/img/chart-01.png" alt="Screenshot of the Charts widget" style="border: 1px solid #bfbfbf; float:right; height:150px; margin: 0 0 8px 8px; width:275px;">
-		The Charts module provides a JavaScript API for visualizing data in a variety of formats across all A-grade browsers. Based on device and browser capabilities, Charts leverages SVG, HTML Canvas and VML to render its graphical elements. 
+		The Charts module provides a JavaScript API for visualizing data in a variety of formats across a <a href="http://developer.yahoo.com/yui/articles/gbs">browser test baseline</a>. Based on device and browser capabilities, Charts leverages SVG, HTML Canvas and VML to render its graphical elements. 
 	</p>
 	<p>
 	The Charts module features a `Chart` class that allows you to easily create a chart from a set of data. `Chart` extends `Widget` and includes configurable attributes that enable you to customize a Chart. Currently, the `Chart` widget can be used to create different variations and combinations of line, marker, area, spline, column, bar and pie charts.

diff --git a/src/charts/js/CartesianChart.js b/src/charts/js/CartesianChart.js
@@ -1209,19 +1209,19 @@ Y.CartesianChart = Y.Base.create("cartesianChart", Y.Widget, [Y.ChartBase], {
          *      <dt>series</dt><dd>A key indexed hash containing references to the `styles` attribute for each series in the chart.
          *      Specific style attributes vary depending on the series:
          *      <ul>
-         *          <li><a href="AreaSeries.html#config_styles">AreaSeries</a></li>
-         *          <li><a href="BarSeries.html#config_styles">BarSeries</a></li>
-         *          <li><a href="ColumnSeries.html#config_styles">ColumnSeries</a></li>
-         *          <li><a href="ComboSeries.html#config_styles">ComboSeries</a></li>
-         *          <li><a href="LineSeries.html#config_styles">LineSeries</a></li>
-         *          <li><a href="MarkerSeries.html#config_styles">MarkerSeries</a></li>
-         *          <li><a href="SplineSeries.html#config_styles">SplineSeries</a></li>
+         *          <li><a href="AreaSeries.html#attrs_styles">AreaSeries</a></li>
+         *          <li><a href="BarSeries.html#attrs_styles">BarSeries</a></li>
+         *          <li><a href="ColumnSeries.html#attrs_styles">ColumnSeries</a></li>
+         *          <li><a href="ComboSeries.html#attrs_styles">ComboSeries</a></li>
+         *          <li><a href="LineSeries.html#attrs_styles">LineSeries</a></li>
+         *          <li><a href="MarkerSeries.html#attrs_styles">MarkerSeries</a></li>
+         *          <li><a href="SplineSeries.html#attrs_styles">SplineSeries</a></li>
          *      </ul>
          *      </dd>
          *      <dt>axes</dt><dd>A key indexed hash containing references to the `styles` attribute for each axes in the chart. Specific
-         *      style attributes can be found in the <a href="Axis.html#config_styles">Axis</a> class.</dd>
+         *      style attributes can be found in the <a href="Axis.html#attrs_styles">Axis</a> class.</dd>
          *      <dt>graph</dt><dd>A reference to the `styles` attribute in the chart. Specific style attributes can be found in the
-         *      <a href="Graph.html#config_styles">Graph</a> class.</dd>
+         *      <a href="Graph.html#attrs_styles">Graph</a> class.</dd>
          *  </dl>
          *
          * @attribute styles

diff --git a/src/charts/js/ComboSeries.js b/src/charts/js/ComboSeries.js
@@ -246,11 +246,11 @@ Y.ComboSeries = Y.Base.create("comboSeries", Y.CartesianSeries, [Y.Fills, Y.Line
          * Style properties for the series. Contains a key indexed hash of the following:
          *  <dl>
          *      <dt>marker</dt><dd>Style properties for the markers in the series. Specific style attributes are listed
-         *      <a href="#config_marker">here</a>.</dd>
+         *      <a href="#attrs_marker">here</a>.</dd>
          *      <dt>line</dt><dd>Style properties for the lines in the series. Specific
-         *      style attributes are listed <a href="#config_line">here</a>.</dd>
+         *      style attributes are listed <a href="#attrs_line">here</a>.</dd>
          *      <dt>area</dt><dd>Style properties for the area fills in the series. Specific style attributes are listed
-         *      <a href="#config_area">here</a>.</dd>
+         *      <a href="#attrs_area">here</a>.</dd>
          *  </dl>
          *
          * @attribute styles

diff --git a/src/graphics/docs/index.mustache b/src/graphics/docs/index.mustache
@@ -1,7 +1,7 @@
 <div class="intro" style="min-height: 184px;">
 	<p>
 		<img src="{{componentAssets}}/img/ship.png" alt="Screencapture of ship drawn with Graphics" style="border: 1px solid #bfbfbf; float:right; height:150px; margin: 0 0 8px 8px; width:275px;">
-		The Graphics module provides a JavaScript API for creating shapes in a variety of formats across all A-grade browsers. Based on device and browser capabilities, Graphics leverages SVG, HTML Canvas and VML to render its graphical elements. 
+		The Graphics module provides a JavaScript API for creating shapes in a variety of formats across a <a href="http://developer.yahoo.com/yui/articles/gbs">browser test baseline</a>. Based on device and browser capabilities, Graphics leverages SVG, HTML Canvas and VML to render its graphical elements. 
 	</p>
 	<p>
 	The Graphics module features a `Graphic` class that allows you to easily create and manage shapes. Currently, a `Graphic` instance can be used to create predifined shapes and free-form polygons with fill and stroke properties.