From 76b265d88c046849d7acc597485f26eef8062aa5 Mon Sep 17 00:00:00 2001
From: Amit Kumar Mondal <mondal@fortiss.org>
Date: Wed, 16 Mar 2016 12:22:57 +0000
Subject: [PATCH] Added more class-level comments (WIP)
---
.../tooling/spiderchart/scale/SpiderChartScale.java | 6 ++++++
.../tooling/spiderchart/sequence/DataSeq.java | 8 +++++++-
.../tooling/spiderchart/sequence/LineDataSeq.java | 6 ++++++
.../fortiss/tooling/spiderchart/style/FillStyle.java | 6 ++++++
.../fortiss/tooling/spiderchart/style/LineStyle.java | 6 ++++++
.../tooling/spiderchart/swt/SpiderChartCanvas.java | 8 +++++++-
.../tooling/spiderchart/swt/SpiderChartViewer.java | 12 +++++++++---
7 files changed, 47 insertions(+), 5 deletions(-)
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/scale/SpiderChartScale.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/scale/SpiderChartScale.java
index 0c9dbf7a7..648db4e69 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/scale/SpiderChartScale.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/scale/SpiderChartScale.java
@@ -17,6 +17,12 @@ $Id: CLASS.java 11213 2016-03-04 16:27:08Z MONDAL $
+--------------------------------------------------------------------------*/
package org.fortiss.tooling.spiderchart.scale;
+/**
+ * Represents chart scales
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class SpiderChartScale {
/** Scaling Max Value (shown exactly as provided) */
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/sequence/DataSeq.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/sequence/DataSeq.java
index dbc586dd0..2445d7a59 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/sequence/DataSeq.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/sequence/DataSeq.java
@@ -27,7 +27,13 @@ import java.util.Locale;
import org.fortiss.tooling.spiderchart.SpiderChart;
-public class DataSeq {
+/**
+ * Class representing sequence of points to be used for plotting
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
+public abstract class DataSeq {
/** Data Point Labels */
private String[] dataLabels;
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/sequence/LineDataSeq.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/sequence/LineDataSeq.java
index 2b0e72491..8962312ff 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/sequence/LineDataSeq.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/sequence/LineDataSeq.java
@@ -32,6 +32,12 @@ import org.fortiss.tooling.spiderchart.gc.AbstractChartImage;
import org.fortiss.tooling.spiderchart.style.FillStyle;
import org.fortiss.tooling.spiderchart.style.LineStyle;
+/**
+ * Represents spider chart data sequence of points for plotting
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class LineDataSeq extends DataSeq {
/** */
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/style/FillStyle.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/style/FillStyle.java
index 691a45034..0f21ad716 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/style/FillStyle.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/style/FillStyle.java
@@ -25,6 +25,12 @@ import org.fortiss.tooling.spiderchart.gc.AbstractChartColor;
import org.fortiss.tooling.spiderchart.gc.AbstractChartGraphics;
import org.fortiss.tooling.spiderchart.gc.AbstractChartImage;
+/**
+ * Represents a style to be used in SWT Chart Graphics
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class FillStyle {
/** Gradient Horizontal Setting */
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/style/LineStyle.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/style/LineStyle.java
index 13ddb8db9..43a25ac5f 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/style/LineStyle.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/style/LineStyle.java
@@ -24,6 +24,12 @@ import static org.fortiss.tooling.spiderchart.gc.AbstractChartGraphics.STROKE_NO
import org.fortiss.tooling.spiderchart.gc.AbstractChartColor;
import org.fortiss.tooling.spiderchart.gc.AbstractChartGraphics;
+/**
+ * Represents a style to be used in SWT Chart Graphics
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class LineStyle {
/** */
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/swt/SpiderChartCanvas.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/swt/SpiderChartCanvas.java
index 5111c53d7..cdf5b699a 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/swt/SpiderChartCanvas.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/swt/SpiderChartCanvas.java
@@ -33,8 +33,14 @@ import org.fortiss.tooling.spiderchart.SpiderChart;
import org.fortiss.tooling.spiderchart.gc.AbstractChartGraphics;
import org.fortiss.tooling.spiderchart.listener.ISpiderChartListener;
+/**
+ * Represents a canvas on which chart will be displayed
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class SpiderChartCanvas extends Canvas implements
- ISpiderChartListener {
+ISpiderChartListener {
/** Actual Spider Chart Ref */
private SpiderChart chart = null;
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/swt/SpiderChartViewer.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/swt/SpiderChartViewer.java
index 9b46d2e9a..494d72a84 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/swt/SpiderChartViewer.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/swt/SpiderChartViewer.java
@@ -35,6 +35,12 @@ import org.eclipse.swt.widgets.Slider;
import org.fortiss.tooling.spiderchart.SpiderChart;
import org.fortiss.tooling.spiderchart.listener.SpiderChartAdapter;
+/**
+ * Represents a viewer on the canvas to display the chart
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class SpiderChartViewer extends Composite {
/** allows zoom functionality on the chart */
@@ -53,11 +59,11 @@ public final class SpiderChartViewer extends Composite {
public void onChartEvent(final SpiderChart c, final int type) {
if (type == 2) {
SpiderChartViewer.this.canvas
- .setCursor(SpiderChartViewer.this.pointCursor);
+ .setCursor(SpiderChartViewer.this.pointCursor);
}
if (type == 3) {
SpiderChartViewer.this.canvas
- .setCursor(SpiderChartViewer.this.defaultCursor);
+ .setCursor(SpiderChartViewer.this.defaultCursor);
}
}
};
@@ -406,7 +412,7 @@ public final class SpiderChartViewer extends Composite {
}
if (this.canvas.getChart().getVirtualWidth() > 0) {
this.vSlider
- .setSize(vSliderWidth, this.getSize().y - hSliderHeight);
+ .setSize(vSliderWidth, this.getSize().y - hSliderHeight);
this.vSlider.setLocation(this.canvas.getSize().x, 0);
this.vSlider.setVisible(true);
this.canvas.getChart().setWithScroll(true);
--
GitLab