[Jfreechart-commit] SF.net SVN: jfreechart: [976] branches/jfreechart-1.0.x-branch/source/org/ jfree/data/gantt/GanttCategoryDataset.java

[<mu...@us...>]

Revision: 976
          http://jfreechart.svn.sourceforge.net/jfreechart/?rev=976&view=rev
Author:   mungady
Date:     2008-05-12 02:09:34 -0700 (Mon, 12 May 2008)

Log Message:
-----------
Updated API docs.

Modified Paths:
--------------
    branches/jfreechart-1.0.x-branch/source/org/jfree/data/gantt/GanttCategoryDataset.java

Modified: branches/jfreechart-1.0.x-branch/source/org/jfree/data/gantt/GanttCategoryDataset.java
===================================================================
--- branches/jfreechart-1.0.x-branch/source/org/jfree/data/gantt/GanttCategoryDataset.java	2008-05-12 09:03:06 UTC (rev 975)
+++ branches/jfreechart-1.0.x-branch/source/org/jfree/data/gantt/GanttCategoryDataset.java	2008-05-12 09:09:34 UTC (rev 976)
@@ -2,32 +2,32 @@
  * JFreeChart : a free chart library for the Java(tm) platform
  * ===========================================================
  *
- * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
+ * (C) Copyright 2000-2008, by Object Refinery Limited and Contributors.
  *
  * Project Info:  http://www.jfree.org/jfreechart/index.html
  *
- * This library is free software; you can redistribute it and/or modify it 
- * under the terms of the GNU Lesser General Public License as published by 
- * the Free Software Foundation; either version 2.1 of the License, or 
+ * This library is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
- * This library is distributed in the hope that it will be useful, but 
- * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
- * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
+ * This library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
  * License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
- * USA.  
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
+ * USA.
  *
- * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
+ * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
  * in the United States and other countries.]
  *
  * -------------------------
  * GanttCategoryDataset.java
  * -------------------------
- * (C) Copyright 2003-2007, by Object Refinery Limited.
+ * (C) Copyright 2003-2008, by Object Refinery Limited.
  *
  * Original Author:  David Gilbert (for Object Refinery Limited);
  * Contributor(s):   -;
@@ -36,6 +36,7 @@
  * -------
  * 16-Sep-2003 : Version 1, based on MultiIntervalCategoryDataset (DG);
  * 23-Sep-2003 : Fixed Checkstyle issues (DG);
+ * 12-May-2008 : Updated API docs (DG);
  *
  */
 
@@ -44,7 +45,7 @@
 import org.jfree.data.category.IntervalCategoryDataset;
 
 /**
- * An extension of the {@link IntervalCategoryDataset} interface that adds 
+ * An extension of the {@link IntervalCategoryDataset} interface that adds
  * support for multiple sub-intervals.
  */
 public interface GanttCategoryDataset extends IntervalCategoryDataset {
@@ -56,6 +57,8 @@
      * @param column  the column index (zero-based).
      *
      * @return The percent complete.
+     *
+     * @see #getPercentComplete(Comparable, Comparable)
      */
     public Number getPercentComplete(int row, int column);
 
@@ -66,6 +69,8 @@
      * @param columnKey  the column key.
      *
      * @return The percent complete.
+     *
+     * @see #getPercentComplete(int, int)
      */
     public Number getPercentComplete(Comparable rowKey, Comparable columnKey);
 
@@ -76,6 +81,8 @@
      * @param column  the column index (zero-based).
      *
      * @return The sub-interval count.
+     *
+     * @see #getSubIntervalCount(Comparable, Comparable)
      */
     public int getSubIntervalCount(int row, int column);
 
@@ -86,6 +93,8 @@
      * @param columnKey  the column key.
      *
      * @return The sub-interval count.
+     *
+     * @see #getSubIntervalCount(int, int)
      */
     public int getSubIntervalCount(Comparable rowKey, Comparable columnKey);
 
@@ -97,6 +106,8 @@
      * @param subinterval  the sub-interval index (zero-based).
      *
      * @return The start value (possibly <code>null</code>).
+     *
+     * @see #getEndValue(int, int, int)
      */
     public Number getStartValue(int row, int column, int subinterval);
 
@@ -108,8 +119,10 @@
      * @param subinterval  the sub-interval.
      *
      * @return The start value (possibly <code>null</code>).
+     *
+     * @see #getEndValue(Comparable, Comparable, int)
      */
-    public Number getStartValue(Comparable rowKey, Comparable columnKey, 
+    public Number getStartValue(Comparable rowKey, Comparable columnKey,
                                 int subinterval);
 
     /**
@@ -120,6 +133,8 @@
      * @param subinterval  the sub-interval.
      *
      * @return The end value (possibly <code>null</code>).
+     *
+     * @see #getStartValue(int, int, int)
      */
     public Number getEndValue(int row, int column, int subinterval);
 
@@ -131,8 +146,10 @@
      * @param subinterval  the sub-interval.
      *
      * @return The end value (possibly <code>null</code>).
+     *
+     * @see #getStartValue(Comparable, Comparable, int)
      */
-    public Number getEndValue(Comparable rowKey, Comparable columnKey, 
+    public Number getEndValue(Comparable rowKey, Comparable columnKey,
                               int subinterval);
 
     /**
@@ -143,6 +160,8 @@
      * @param subinterval  the sub-interval.
      *
      * @return The percent complete value (possibly <code>null</code>).
+     *
+     * @see #getPercentComplete(Comparable, Comparable, int)
      */
     public Number getPercentComplete(int row, int column, int subinterval);
 
@@ -153,9 +172,11 @@
      * @param columnKey  the column key.
      * @param subinterval  the sub-interval.
      *
-     * @return The precent complete value (possibly <code>null</code>).
+     * @return The percent complete value (possibly <code>null</code>).
+     *
+     * @see #getPercentComplete(int, int, int)
      */
-    public Number getPercentComplete(Comparable rowKey, Comparable columnKey, 
+    public Number getPercentComplete(Comparable rowKey, Comparable columnKey,
                                      int subinterval);
 
 }


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.