From: David G. <mu...@us...> - 2006-02-10 16:14:33
|
Update of /cvsroot/jfreechart/jfreechart/source/org/jfree/chart/axis In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv32306/source/org/jfree/chart/axis Modified Files: DateAxis.java NumberAxis.java Log Message: 2006-02-10 David Gilbert <dav...@ob...> * source/org/jfree/chart/axis/DateAxis.java: Updated API docs, * source/org/jfree/chart/axis/NumberAxis.java: Likewise. Index: NumberAxis.java =================================================================== RCS file: /cvsroot/jfreechart/jfreechart/source/org/jfree/chart/axis/NumberAxis.java,v retrieving revision 1.17 retrieving revision 1.18 diff -C2 -d -r1.17 -r1.18 *** NumberAxis.java 17 Jun 2005 09:56:34 -0000 1.17 --- NumberAxis.java 10 Feb 2006 16:14:17 -0000 1.18 *************** *** 3,7 **** * =========================================================== * ! * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors. * * Project Info: http://www.jfree.org/jfreechart/index.html --- 3,7 ---- * =========================================================== * ! * (C) Copyright 2000-2006, by Object Refinery Limited and Contributors. * * Project Info: http://www.jfree.org/jfreechart/index.html *************** *** 17,23 **** * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. * * [Java is a trademark or registered trademark of Sun Microsystems, Inc. --- 17,24 ---- * 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. * * [Java is a trademark or registered trademark of Sun Microsystems, Inc. *************** *** 27,31 **** * NumberAxis.java * --------------- ! * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors. * * Original Author: David Gilbert (for Object Refinery Limited); --- 28,32 ---- * NumberAxis.java * --------------- ! * (C) Copyright 2000-2006, by Object Refinery Limited and Contributors. * * Original Author: David Gilbert (for Object Refinery Limited); *************** *** 83,86 **** --- 84,88 ---- * (and likewise the vertical version) for consistency with * other axis classes (DG); + * 10-Feb-2006 : Added some API doc comments in respect of bug 821046 (DG); * */ *************** *** 174,178 **** /** An optional band for marking regions on the axis. */ private MarkerAxisBand markerBand; ! /** * Default constructor. --- 176,180 ---- /** An optional band for marking regions on the axis. */ private MarkerAxisBand markerBand; ! /** * Default constructor. *************** *** 277,283 **** /** ! * Returns the tick unit for the axis. * * @return The tick unit for the axis. */ public NumberTickUnit getTickUnit() { --- 279,293 ---- /** ! * Returns the tick unit for the axis. ! * <p> ! * Note: if the <code>autoTickUnitSelection</code> flag is ! * <code>true</code> the tick unit may be changed while the axis is being ! * drawn, so in that case the return value from this method may be ! * irrelevant if the method is called before the axis has been drawn. * * @return The tick unit for the axis. + * + * @see #setTickUnit(NumberTickUnit) + * @see ValueAxis#isAutoTickUnitSelection() */ public NumberTickUnit getTickUnit() { *************** *** 293,296 **** --- 303,309 ---- * * @param unit the new tick unit (<code>null</code> not permitted). + * + * @see #getTickUnit() + * @see #setTickUnit(NumberTickUnit, boolean, boolean) */ public void setTickUnit(NumberTickUnit unit) { *************** *** 582,586 **** } ! /** * Draws the axis on a Java 2D graphics device (such as the screen or a --- 595,599 ---- } ! /** * Draws the axis on a Java 2D graphics device (such as the screen or a Index: DateAxis.java =================================================================== RCS file: /cvsroot/jfreechart/jfreechart/source/org/jfree/chart/axis/DateAxis.java,v retrieving revision 1.18 retrieving revision 1.19 diff -C2 -d -r1.18 -r1.19 *** DateAxis.java 17 Jun 2005 09:56:34 -0000 1.18 --- DateAxis.java 10 Feb 2006 16:14:17 -0000 1.19 *************** *** 3,7 **** * =========================================================== * ! * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors. * * Project Info: http://www.jfree.org/jfreechart/index.html --- 3,7 ---- * =========================================================== * ! * (C) Copyright 2000-2006, by Object Refinery Limited and Contributors. * * Project Info: http://www.jfree.org/jfreechart/index.html *************** *** 17,23 **** * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. * * [Java is a trademark or registered trademark of Sun Microsystems, Inc. --- 17,24 ---- * 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. * * [Java is a trademark or registered trademark of Sun Microsystems, Inc. *************** *** 27,31 **** * DateAxis.java * ------------- ! * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors. * * Original Author: David Gilbert; --- 28,32 ---- * DateAxis.java * ------------- ! * (C) Copyright 2000-2006, by Object Refinery Limited and Contributors. * * Original Author: David Gilbert; *************** *** 104,107 **** --- 105,109 ---- * 21-Apr-2005 : Replaced Insets with RectangleInsets, removed redundant * argument from selectAutoTickUnit() (DG); + * 10-Feb-2006 : Added some API doc comments in respect of bug 821046 (DG); * */ *************** *** 185,189 **** */ private DateTickMarkPosition tickMarkPosition = DateTickMarkPosition.START; ! /** * A timeline that includes all milliseconds (as defined by --- 187,191 ---- */ private DateTickMarkPosition tickMarkPosition = DateTickMarkPosition.START; ! /** * A timeline that includes all milliseconds (as defined by *************** *** 375,380 **** --- 377,390 ---- /** * Returns the tick unit for the axis. + * <p> + * Note: if the <code>autoTickUnitSelection</code> flag is + * <code>true</code> the tick unit may be changed while the axis is being + * drawn, so in that case the return value from this method may be + * irrelevant if the method is called before the axis has been drawn. * * @return The tick unit (possibly <code>null</code>). + * + * @see #setTickUnit(NumberTickUnit) + * @see ValueAxis#isAutoTickUnitSelection() */ public DateTickUnit getTickUnit() { *************** *** 388,391 **** --- 398,404 ---- * * @param unit the tick unit. + * + * @see #getTickUnit() + * @see #setTickUnit(DateTickUnit, boolean, boolean) */ public void setTickUnit(DateTickUnit unit) { *************** *** 394,402 **** /** ! * Sets the tick unit attribute without any other side effects. * * @param unit the new tick unit. * @param notify notify registered listeners? * @param turnOffAutoSelection turn off auto selection? */ public void setTickUnit(DateTickUnit unit, boolean notify, --- 407,417 ---- /** ! * Sets the tick unit attribute. * * @param unit the new tick unit. * @param notify notify registered listeners? * @param turnOffAutoSelection turn off auto selection? + * + * @see #getTickUnit() */ public void setTickUnit(DateTickUnit unit, boolean notify, *************** *** 1634,1638 **** return result; } ! /** * Draws the axis on a Java 2D graphics device (such as the screen or a --- 1649,1653 ---- return result; } ! /** * Draws the axis on a Java 2D graphics device (such as the screen or a |