refs bug 302220 - updated javadocs
diff --git a/bundles/org.eclipse.rap.rwt.visualization.google/src/org/eclipse/rap/rwt/visualization/google/AnnotatedTimeLine.java b/bundles/org.eclipse.rap.rwt.visualization.google/src/org/eclipse/rap/rwt/visualization/google/AnnotatedTimeLine.java
index 13c2f60..1a6bf76 100644
--- a/bundles/org.eclipse.rap.rwt.visualization.google/src/org/eclipse/rap/rwt/visualization/google/AnnotatedTimeLine.java
+++ b/bundles/org.eclipse.rap.rwt.visualization.google/src/org/eclipse/rap/rwt/visualization/google/AnnotatedTimeLine.java
@@ -15,45 +15,44 @@
import org.eclipse.swt.widgets.Composite;
/**
- * Renders a Google Visualization Annotated Timeline.
- * @See http://code.google.com/apis/visualization/documentation/gallery/annotatedtimeline.html
- *
- * Note that although the documentation on this widget suggest you
- * can add columns to contain annotations of the points on the timeline,
- * I have received an error when i try to add such string columns of data.
- *
- * Note that this widget is rendered upon calling the setWidgetData method.
- * So if you wish to set options like width, height, colors, etc., you must do this
- * using method setWidgetOptions, before calling setWidgetData.
- *
- * Usage:
- * <code>
+ * <p>Renders a Google Visualization Annotated Timeline.</p>
+ * <p>
+ * This visualization is configured using the widget data and options
+ * set by <code>setWidgetData()</code> and <code>setWidgetOptions()</code>.
+ * Note that if the widget data or options are changed after initial rendering,
+ * the <code>redraw()</code> method should be called to render the changes.
+ * </p>
+ * <p>
+ * <b>Usage:</b>
+ * <pre>
* JSONGoogleDataTable dataTable = new JSONGoogleDataTable();
- dataTable.addColumn("Date", "Date", "date", null);
- dataTable.addColumn("AverageGPA", "Average GPA", "number", null);
- dataTable.addRow(new Object[] {new Date(1210000000), 3});
- dataTable.addRow(new Object[] {new Date(1230809560), 3.5});
- dataTable.addRow(new Object[] {new Date(), 2.85});
- widgetData = dataTable.toString();
-
- AnnotatedTimeLine timeLine = new AnnotatedTimeLine( composite, SWT.NONE );
- timeLine.setWidgetOptions("{width: 500, height: 300, displayAnnotations: true}");
- timeLine.setWidgetData(widgetData);
- gridData = new GridData(500, 300);
- timeLine.setLayoutData(gridData);
- timeLine.addListener(SWT.Selection, this);
- </code>
-
- <code>
- public void handleEvent(Event event) {
- log.info("Event: " + event);
- VisualizationWidget widget = (VisualizationWidget)event.widget;
- log.info( "Selected item=" + widget.getSelectedItem() +
- "; row=" + widget.getSelectedRow() +
- "; column=" + widget.getSelectedColumn() +
- "; value=" + widget.getSelectedValue());
- </code>
- }
+ * dataTable.addColumn("Date", "Date", "date", null);
+ * dataTable.addColumn("AverageGPA", "Average GPA", "number", null);
+ * dataTable.addRow(new Object[] {new Date(1210000000), 3});
+ * dataTable.addRow(new Object[] {new Date(1230809560), 3.5});
+ * dataTable.addRow(new Object[] {new Date(), 2.85});
+ * widgetData = dataTable.toString();
+ *
+ * AnnotatedTimeLine timeLine = new AnnotatedTimeLine( composite, SWT.NONE );
+ * timeLine.setWidgetOptions("{width: 500, height: 300, displayAnnotations: true}");
+ * timeLine.setWidgetData(widgetData);
+ * gridData = new GridData(500, 300);
+ * timeLine.setLayoutData(gridData);
+ * timeLine.addListener(SWT.Selection, this);
+ * </pre>
+ * </p>
+ * <pre>
+ * public void handleEvent(Event event) {
+ * System.out.println("Event: " + event);
+ * VisualizationWidget widget = (VisualizationWidget)event.widget;
+ * System.out.println("Selected item=" + widget.getSelectedItem() +
+ * "; row=" + widget.getSelectedRow() +
+ * "; column=" + widget.getSelectedColumn() +
+ * "; value=" + widget.getSelectedValue());
+ * }
+ * </pre>
+ * </p>
+ * @see <a href="http://code.google.com/apis/visualization/documentation/gallery/annotatedtimeline.html">Annotated Timeline Example</a>
*
*/
public class AnnotatedTimeLine extends VisualizationWidget {
diff --git a/bundles/org.eclipse.rap.rwt.visualization.google/src/org/eclipse/rap/rwt/visualization/google/AreaChart.java b/bundles/org.eclipse.rap.rwt.visualization.google/src/org/eclipse/rap/rwt/visualization/google/AreaChart.java
index e4abd47..0451a51 100644
--- a/bundles/org.eclipse.rap.rwt.visualization.google/src/org/eclipse/rap/rwt/visualization/google/AreaChart.java
+++ b/bundles/org.eclipse.rap.rwt.visualization.google/src/org/eclipse/rap/rwt/visualization/google/AreaChart.java
@@ -16,39 +16,42 @@
/**
* Renders a Google Visualization Area Chart.
- * @See http://code.google.com/apis/visualization/documentation/gallery/areachart.html
- *
- * Note that this widget is rendered upon calling the setWidgetData method.
- * So if you wish to set options like width, height, colors, etc., you must do this
- * using method setWidgetOptions, before calling setWidgetData.
- *
- * Usage:<code>
+ * <p>
+ * This visualization is configured using the widget data and options
+ * set by <code>setWidgetData()</code> and <code>setWidgetOptions()</code>.
+ * Note that if the widget data or options are changed after initial rendering,
+ * the <code>redraw()</code> method should be called to render the changes.
+ * </p>
+ * <p>
+ * <b>Usage:</b>
+ * <pre>
* JSONGoogleDataTable dataTable = new JSONGoogleDataTable();
- dataTable.addColumn("theyear", "Date", "string", null);
- dataTable.addColumn("CO2", "CO2", "number", null);
- dataTable.addColumn("Temperature", "Temperature", "number", null);
- dataTable.addRow(new Object[] {"1970", 325, 14.1});
- dataTable.addRow(new Object[] {"2009", 389, 14.7});
- widgetData = dataTable.toString();
-
- AreaChart barChart = new AreaChart( composite, SWT.NONE );
- barChart.setWidgetOptions("{width: 300, height: 300}");
- barChart.setWidgetData(widgetData);
- gridData = new GridData(300, 300);
- barChart.setLayoutData(gridData);
- barChart.addListener(SWT.Selection, this);
- * </code>
-
- <code>
- public void handleEvent(Event event) {
- log.info("Event: " + event);
- VisualizationWidget widget = (VisualizationWidget)event.widget;
- log.info( "Selected item=" + widget.getSelectedItem() +
- "; row=" + widget.getSelectedRow() +
- "; column=" + widget.getSelectedColumn() +
- "; value=" + widget.getSelectedValue());
- </code>
- *
+ * dataTable.addColumn("theyear", "Date", "string", null);
+ * dataTable.addColumn("CO2", "CO2", "number", null);
+ * dataTable.addColumn("Temperature", "Temperature", "number", null);
+ * dataTable.addRow(new Object[] {"1970", 325, 14.1});
+ * dataTable.addRow(new Object[] {"2009", 389, 14.7});
+ * widgetData = dataTable.toString();
+ *
+ * AreaChart barChart = new AreaChart( composite, SWT.NONE );
+ * barChart.setWidgetOptions("{width: 300, height: 300}");
+ * barChart.setWidgetData(widgetData);
+ * gridData = new GridData(300, 300);
+ * barChart.setLayoutData(gridData);
+ * barChart.addListener(SWT.Selection, this);
+ * </pre>
+ * </p>
+ * <pre>
+ * public void handleEvent(Event event) {
+ * System.out.println("Event: " + event);
+ * VisualizationWidget widget = (VisualizationWidget)event.widget;
+ * System.out.println("Selected item=" + widget.getSelectedItem() +
+ * "; row=" + widget.getSelectedRow() +
+ * "; column=" + widget.getSelectedColumn() +
+ * "; value=" + widget.getSelectedValue());
+ * }
+ * </pre>
+ * @see <a href="http://code.google.com/apis/visualization/documentation/gallery/areachart.html">Area Chart Example</a>
*/
public class AreaChart extends VisualizationWidget {
