Revision: 878
Author: heuermh
Date: Sat Oct 31 19:26:38 2009
Log: adding @since 1.3 tags in core where clirr report identified new items
http://code.google.com/p/piccolo2d/source/detail?r=878
Modified:
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PCamera.java
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PCanvas.java
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PNode.java
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/POffscreenCanvas.java
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PRoot.java
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/activities/PInterpolatingActivity.java
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/event/PPanEventHandler.java
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/nodes/PHtmlView.java
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/nodes/PText.java
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransform.java
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransformException.java
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/util/PPaintContext.java
=======================================
---
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PCamera.java
Sat Oct 24 08:13:41 2009
+++
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PCamera.java
Sat Oct 31 19:26:38 2009
@@ -196,6 +196,7 @@
* in Piccolo2D this one must not modify the <code>viewBounds</code>
* parameter.
*
+ * @since 1.3
* @param viewBounds bounds that require repainting, in view
coordinates
* @param repaintedLayer layer dispatching the repaint notification
*/
=======================================
---
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PCanvas.java
Sat Oct 24 08:03:14 2009
+++
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PCanvas.java
Sat Oct 31 19:26:38 2009
@@ -86,12 +86,15 @@
/**
* The property name that identifies a change in the interacting state.
*
+ * @since 1.3
* @deprecated in favor of PROPERTY_INTERACTING
*/
public static final String INTERACTING_CHANGED_NOTIFICATION
= "INTERACTING_CHANGED_NOTIFICATION";
/**
* The property name that identifies a change in the interacting state.
+ *
+ * @since 1.3
*/
public static final String PROPERTY_INTERACTING
= "INTERACTING_CHANGED_NOTIFICATION";
@@ -648,6 +651,7 @@
/**
* Returns the quality to use when not animating or interacting.
*
+ * @since 1.3
* @deprecated in favor or getNormalRenderQuality
* @return the render quality to use when not animating or interacting
*/
@@ -658,6 +662,7 @@
/**
* Returns the quality to use when not animating or interacting.
*
+ * @since 1.3
* @return the render quality to use when not animating or interacting
*/
public int getNormalRenderQuality() {
@@ -667,6 +672,7 @@
/**
* Returns the quality to use when animating.
*
+ * @since 1.3
* @return Returns the quality to use when animating
*/
public int getAnimatingRenderQuality() {
@@ -676,6 +682,7 @@
/**
* Returns the quality to use when interacting.
*
+ * @since 1.3
* @return Returns the quality to use when interacting
*/
public int getInteractingRenderQuality() {
@@ -685,6 +692,7 @@
/**
* Returns the input event listeners registered to receive input
events.
*
+ * @since 1.3
* @return array or input event listeners
*/
public PInputEventListener[] getInputEventListeners() {
=======================================
--- /piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PNode.java
Fri Oct 23 15:21:11 2009
+++ /piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PNode.java
Sat Oct 31 19:26:38 2009
@@ -363,12 +363,16 @@
/**
* toImage fill strategy that stretches the node be as large as
possible
* while still retaining its aspect ratio.
+ *
+ * @since 1.3
*/
public static final int FILL_STRATEGY_ASPECT_FIT = 1;
/**
* toImage fill strategy that stretches the node be large enough to
cover
* the image, and centers it.
+ *
+ * @since 1.3
*/
public static final int FILL_STRATEGY_ASPECT_COVER = 2;
@@ -376,12 +380,15 @@
* toImage fill strategy that stretches the node to be exactly the
* dimensions of the image. Will result in distortion if the aspect
ratios
* are different.
+ *
+ * @since 1.3
*/
public static final int FILL_STRATEGY_EXACT_FIT = 4;
/**
* Creates a new PNode with the given name.
*
+ * @since 1.3
* @param newName name to assign to node
*/
public PNode(final String newName) {
@@ -2356,6 +2363,7 @@
* same place as the upper-left corner of B, and the transition will be
* smoothly animated over a period of 750 milliseconds.
*
+ * @since 1.3
* @param srcPt The anchor point on this transform's node (normalized
to a
* unit square)
* @param destPt The anchor point on destination bounds (normalized to
a
@@ -2890,6 +2898,7 @@
* background, paint is null, then the image will not be filled with a
color
* prior to rendering
*
+ * @since 1.3
* @param image Image onto which this node will be painted
* @param backGroundPaint will fill background of image with this. May
be
* null.
@@ -3511,6 +3520,7 @@
/**
* Sets the name of this null, may be null.
*
+ * @since 1.3
* @param name new name for this node
*/
public void setName(final String name) {
@@ -3520,6 +3530,7 @@
/**
* Returns the name given to this node.
*
+ * @since 1.3
* @return name given to this node, may be null
*/
public String getName() {
@@ -3684,6 +3695,7 @@
/**
* Returns an array of input event listeners that are attached to this
node.
*
+ * @since 1.3
* @return event listeners attached to this node
*/
public PInputEventListener[] getInputEventListeners() {
=======================================
---
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/POffscreenCanvas.java
Thu Oct 8 11:45:55 2009
+++
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/POffscreenCanvas.java
Sat Oct 31 19:26:38 2009
@@ -37,6 +37,8 @@
/**
* Offscreen canvas.
+ *
+ * @since 1.3
*/
public final class POffscreenCanvas implements PComponent {
=======================================
--- /piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PRoot.java
Thu Oct 22 19:46:54 2009
+++ /piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PRoot.java
Sat Oct 31 19:26:38 2009
@@ -77,12 +77,16 @@
/**
* The property name that identifies a change in this node's
interacting
* state.
+ *
+ * @since 1.3
*/
public static final String PROPERTY_INTERACTING_CHANGED
= "INTERACTING_CHANGED_NOTIFICATION";
/**
* The property code that identifies a change in this node's
interacting
* state.
+ *
+ * @since 1.3
*/
public static final int PROPERTY_CODE_INTERACTING_CHANGED = 1 << 13;
@@ -205,7 +209,8 @@
* Return true if this root has been marked as interacting. If so the
root
* will normally render at a lower quality that is faster.
*
- * @return True if this root has user interaction taking place
+ * @since 1.3
+ * @return true if this root has user interaction taking place
*/
public boolean getInteracting() {
return interacting > 0;
@@ -220,6 +225,7 @@
* but this is the appropriate place to mark interactions that may
occur in
* multiple canvases if this Root is shared.
*
+ * @since 1.3
* @param isInteracting True if this root has user interaction taking
place
* @see PCanvas#setInteracting(boolean)
*/
=======================================
---
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/activities/PInterpolatingActivity.java
Tue Oct 27 12:09:32 2009
+++
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/activities/PInterpolatingActivity.java
Sat Oct 31 19:26:38 2009
@@ -74,6 +74,7 @@
/**
* Constructs an interpolating activity that will last the duration
given.
*
+ * @since 1.3
* @param duration duration in milliseconds of the entire activity
*/
public PInterpolatingActivity(final long duration) {
=======================================
---
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/event/PPanEventHandler.java
Mon Oct 12 18:58:11 2009
+++
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/event/PPanEventHandler.java
Sat Oct 31 19:26:38 2009
@@ -134,6 +134,7 @@
/**
* Returns the minAutoPan speed in pixels per second.
*
+ * @since 1.3
* @return minimum distance the autopan feature can pan the view
*/
public double getMinAutoPanSpeed() {
@@ -143,6 +144,7 @@
/**
* Returns the maxAutoPan speed in pixels per second.
*
+ * @since 1.3
* @return max distance the autopan feature can pan the view by
*/
public double getMaxAutoPanSpeed() {
=======================================
---
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/nodes/PHtmlView.java
Thu Oct 22 19:46:54 2009
+++
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/nodes/PHtmlView.java
Sat Oct 31 19:26:38 2009
@@ -48,6 +48,7 @@
* the hood so you have the same restrictions regarding HTML as you have
when
* using standard Swing components (HTML 3.2 + subset of CSS 1.0).
*
+ * @since 1.3
* @author Chris Malley ([email protected])
* @author Sam Reid
* @author Allain Lalonde
=======================================
---
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/nodes/PText.java
Thu Oct 22 19:46:54 2009
+++
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/nodes/PText.java
Sat Oct 31 19:26:38 2009
@@ -90,6 +90,8 @@
* The property name that identifies a change of this node's text
paint (see
* {...@link #getTextPaint getTextPaint}). Both old and new value will be
set
* in any property change event.
+ *
+ * @since 1.3
*/
public static final String PROPERTY_TEXT_PAINT = "text paint";
@@ -97,6 +99,8 @@
* The property code that identifies a change of this node's text
paint (see
* {...@link #getTextPaint getTextPaint}). Both old and new value will be
set
* in any property change event.
+ *
+ * @since 1.3
*/
public static final int PROPERTY_CODE_TEXT_PAINT = 1 << 21;
@@ -114,13 +118,25 @@
*/
public static double DEFAULT_GREEK_THRESHOLD = 5.5d;
- /** Default horizontal alignment,
<code>Component.LEFT_ALIGNMENT</code>. */
+ /**
+ * Default horizontal alignment, <code>Component.LEFT_ALIGNMENT</code>.
+ *
+ * @since 1.3
+ */
public static final float DEFAULT_HORIZONTAL_ALIGNMENT =
Component.LEFT_ALIGNMENT;
- /** Default text, <code>""</code>. */
+ /**
+ * Default text, <code>""</code>.
+ *
+ * @since 1.3
+ */
public static final String DEFAULT_TEXT = "";
- /** Default text paint, <code>Color.BLACK</code>. */
+ /**
+ * Default text paint, <code>Color.BLACK</code>.
+ *
+ * @since 1.3
+ */
public static final Paint DEFAULT_TEXT_PAINT = Color.BLACK;
/** Empty text layout array. */
@@ -202,6 +218,7 @@
* <code>Component.RIGHT_ALIGNMENT</code>. Defaults to
* {...@link #DEFAULT_HORIZONTAL_ALIGNMENT}.
*
+ * @since 1.3
* @return the horizontal alignment for this text node
*/
public float getHorizontalAlignment() {
@@ -212,6 +229,7 @@
* Set the horizontal alignment for this text node to
* <code>horizontalAlignment</code>.
*
+ * @since 1.3
* @param horizontalAlignment horizontal alignment, must be one of
* <code>Component.LEFT_ALIGNMENT</code>,
* <code>Component.CENTER_ALIGNMENT</code>, or
@@ -505,6 +523,7 @@
/**
* Paint greek with the specified paint context.
*
+ * @since 1.3
* @param paintContext paint context
*/
protected void paintGreek(final PPaintContext paintContext) {
@@ -514,6 +533,7 @@
/**
* Paint text with the specified paint context.
*
+ * @since 1.3
* @param paintContext paint context
*/
protected void paintText(final PPaintContext paintContext) {
=======================================
---
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransform.java
Mon Aug 3 10:19:18 2009
+++
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransform.java
Sat Oct 31 19:26:38 2009
@@ -262,6 +262,7 @@
/**
* Applies the inverse of this transform to the source point if
possible.
*
+ * @since 1.3
* @param ptSrc point to be transformed
* @param ptDst result of transform will be placed in this point
*
=======================================
---
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransformException.java
Mon Aug 3 19:46:04 2009
+++
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransformException.java
Sat Oct 31 19:26:38 2009
@@ -2,6 +2,8 @@
/**
* This class is used to encapsulate exceptions that may occur while
performing transform operations.
+ *
+ * @since 1.3
*/
public class PAffineTransformException extends RuntimeException {
/**
=======================================
---
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/util/PPaintContext.java
Mon Oct 19 13:38:38 2009
+++
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/util/PPaintContext.java
Sat Oct 31 19:26:38 2009
@@ -173,6 +173,8 @@
/**
* Removes the camera at the top of the camera stack.
+ *
+ * @since 1.3
*/
public void popCamera() {
cameraStack.pop();
--~--~---------~--~----~------------~-------~--~----~
Piccolo2D Developers Group: http://groups.google.com/group/piccolo2d-dev?hl=en
-~----------~----~----~----~------~----~------~--~---
