diff --git a/core/src/main/java/org/piccolo2d/PNode.java b/core/src/main/java/org/piccolo2d/PNode.java index d89aca2..1144309 100644 --- a/core/src/main/java/org/piccolo2d/PNode.java +++ b/core/src/main/java/org/piccolo2d/PNode.java @@ -112,7 +112,7 @@ /** * The property name that identifies a change in this node's client - * propertie (see {@link #getClientProperty getClientProperty}). In an + * properties (see {@link #getClientProperties getClientProperties}). In an * property change event the new value will be a reference to the map of * client properties but old value will always be null. */ @@ -120,7 +120,7 @@ /** * The property code that identifies a change in this node's client - * propertie (see {@link #getClientProperty getClientProperty}). In an + * properties (see {@link #getClientProperties getClientProperties}). In an * property change event the new value will be a reference to the map of * client properties but old value will always be null. */ @@ -2964,7 +2964,7 @@ /** * Constructs a new PrinterJob, allows the user to select which printer to * print to, And then prints the node. - * @throws PrinterException + * @throws PrinterException if print fails */ public void print() throws PrinterException { final PrinterJob printJob = PrinterJob.getPrinterJob(); diff --git a/core/src/main/java/org/piccolo2d/PRoot.java b/core/src/main/java/org/piccolo2d/PRoot.java index 79432d2..0ccb877 100644 --- a/core/src/main/java/org/piccolo2d/PRoot.java +++ b/core/src/main/java/org/piccolo2d/PRoot.java @@ -221,7 +221,7 @@ * Set if this root is interacting. If so the root will normally render at a * lower quality that is faster. Also repaints the root if the the * interaction has ended. - *

+ *

* This has similar functionality to the setInteracting method on Canvas, * but this is the appropriate place to mark interactions that may occur in * multiple canvases if this Root is shared. diff --git a/core/src/main/java/org/piccolo2d/activities/PInterpolatingActivity.java b/core/src/main/java/org/piccolo2d/activities/PInterpolatingActivity.java index e5bc9b3..284d42b 100644 --- a/core/src/main/java/org/piccolo2d/activities/PInterpolatingActivity.java +++ b/core/src/main/java/org/piccolo2d/activities/PInterpolatingActivity.java @@ -274,7 +274,7 @@ /** * Called whenever the activity finishes. Reschedules it if the value of - * loopCount is > 0. + * loopCount is > 0. */ protected void activityFinished() { setRelativeTargetValueAdjustingForMode(1); diff --git a/core/src/main/java/org/piccolo2d/event/PZoomEventHandler.java b/core/src/main/java/org/piccolo2d/event/PZoomEventHandler.java index 9ed6f5a..857b4ed 100644 --- a/core/src/main/java/org/piccolo2d/event/PZoomEventHandler.java +++ b/core/src/main/java/org/piccolo2d/event/PZoomEventHandler.java @@ -48,10 +48,8 @@ * this: *

* - * 

  * zoomEventHandler.getEventFilter().setAndMask(InputEvent.BUTTON1_MASK | 
  *                                              InputEvent.SHIFT_MASK);
- *
* *

* diff --git a/examples/src/main/java/org/piccolo2d/examples/BirdsEyeViewExample.java b/examples/src/main/java/org/piccolo2d/examples/BirdsEyeViewExample.java index 99bdab1..25068e1 100644 --- a/examples/src/main/java/org/piccolo2d/examples/BirdsEyeViewExample.java +++ b/examples/src/main/java/org/piccolo2d/examples/BirdsEyeViewExample.java @@ -371,6 +371,8 @@ /** * Add a layer to list of viewed layers + * + * @param new_layer layer to add */ public void addLayer(final PLayer new_layer) { getCamera().addLayer(new_layer); @@ -379,6 +381,8 @@ /** * Remove the layer from the viewed layers + * + * @param old_layer layer to remove */ public void removeLayer(final PLayer old_layer) { getCamera().removeLayer(old_layer); @@ -475,4 +479,4 @@ } // class BirdsEyeView -} \ No newline at end of file +} diff --git a/examples/src/main/java/org/piccolo2d/examples/issues/ActivityMemoryLeakBugExample.java b/examples/src/main/java/org/piccolo2d/examples/issues/ActivityMemoryLeakBugExample.java index 5eb034b..d8b9bf0 100644 --- a/examples/src/main/java/org/piccolo2d/examples/issues/ActivityMemoryLeakBugExample.java +++ b/examples/src/main/java/org/piccolo2d/examples/issues/ActivityMemoryLeakBugExample.java @@ -43,9 +43,9 @@ /** * Example that demonstrates the memory leak in Issue 185. *

- * Memory leak - PActivityScheduler keeps processed activities in reference
- * http://code.google.com/p/piccolo2d/issues/detail?id=185 - *

+ * Memory leak - PActivityScheduler keeps processed activities in reference + *

+ * https://github.com/piccolo2d/piccolo2d.java/issues/185 */ public class ActivityMemoryLeakBugExample extends PFrame { diff --git a/examples/src/main/java/org/piccolo2d/examples/issues/FrameCanvasSizeBugExample.java b/examples/src/main/java/org/piccolo2d/examples/issues/FrameCanvasSizeBugExample.java index b2e180c..718cc7e 100644 --- a/examples/src/main/java/org/piccolo2d/examples/issues/FrameCanvasSizeBugExample.java +++ b/examples/src/main/java/org/piccolo2d/examples/issues/FrameCanvasSizeBugExample.java @@ -38,7 +38,7 @@ /** * This example demonstrates a bug with setting the size - * of a PFrame. See http://code.google.com/p/piccolo2d/issues/detail?id=141. + * of a PFrame. See https://github.com/piccolo2d/piccolo2d.java/issues/141. */ public class FrameCanvasSizeBugExample extends PFrame { diff --git a/examples/src/main/java/org/piccolo2d/examples/issues/ZeroWidthStrokeBug.java b/examples/src/main/java/org/piccolo2d/examples/issues/ZeroWidthStrokeBug.java index cfc16fb..07b2149 100644 --- a/examples/src/main/java/org/piccolo2d/examples/issues/ZeroWidthStrokeBug.java +++ b/examples/src/main/java/org/piccolo2d/examples/issues/ZeroWidthStrokeBug.java @@ -37,8 +37,9 @@ /** * Example that demonstrates issue with zero width strokes in Issue 221. *

- * Cannot draw veritical and horizontal lines of 0 width stroke using PPath
- * http://code.google.com/p/piccolo2d/issues/detail?id=221 + * Cannot draw veritical and horizontal lines of 0 width stroke using PPath + *

+ * https://github.com/piccolo2d/piccolo2d.java/issues/221 *

*/ public class ZeroWidthStrokeBug extends PFrame { diff --git a/examples/src/main/java/org/piccolo2d/examples/pswing/issues/PSwingCameraBug.java b/examples/src/main/java/org/piccolo2d/examples/pswing/issues/PSwingCameraBug.java index e5f9489..a81c655 100644 --- a/examples/src/main/java/org/piccolo2d/examples/pswing/issues/PSwingCameraBug.java +++ b/examples/src/main/java/org/piccolo2d/examples/pswing/issues/PSwingCameraBug.java @@ -39,8 +39,9 @@ /** * Example that demonstrates the PSwing camera bug described in Issue 148. *

- * PSwing nodes doen't handle interactions when added to the camera
- * http://code.google.com/p/piccolo2d/issues/detail?id=148 + * PSwing nodes doen't handle interactions when added to the camera + *

+ * https://github.com/piccolo2d/piccolo2d.java/issues/148 *

*/ public class PSwingCameraBug { @@ -79,4 +80,4 @@ textField.setPreferredSize(new Dimension(100, 20)); return new PSwing(textField); } -} \ No newline at end of file +} diff --git a/extras/src/main/java/org/piccolo2d/extras/activities/PPathActivity.java b/extras/src/main/java/org/piccolo2d/extras/activities/PPathActivity.java index 9c7d021..b67e8be 100644 --- a/extras/src/main/java/org/piccolo2d/extras/activities/PPathActivity.java +++ b/extras/src/main/java/org/piccolo2d/extras/activities/PPathActivity.java @@ -54,7 +54,7 @@ /** * The "knots" that define this path's activity timing through its activity * and should be an monotonously increasing array starting where each value - * is >=0 and ending at 1f. + * is >=0 and ending at 1f. */ protected float[] knots; diff --git a/extras/src/main/java/org/piccolo2d/extras/pswing/PSwing.java b/extras/src/main/java/org/piccolo2d/extras/pswing/PSwing.java index bc5e128..d69d09f 100644 --- a/extras/src/main/java/org/piccolo2d/extras/pswing/PSwing.java +++ b/extras/src/main/java/org/piccolo2d/extras/pswing/PSwing.java @@ -146,14 +146,14 @@ * PSwing is used to add Swing Components to a Piccolo2D canvas. *

* Example: adding a swing JButton to a PCanvas: - * + * * 

  * PSwingCanvas canvas = new PSwingCanvas();
  * JButton button = new JButton("Button");
  * swing = new PSwing(canvas, button);
  * canvas.getLayer().addChild(swing);
  *
- * + * *

* NOTE: PSwing has the current limitation that it does not listen for Container * events. This is only an issue if you create a PSwing and later add Swing @@ -163,7 +163,7 @@ *

*

* For instance, the following bit of code will give unexpected results: - * + * * 

  * JPanel panel = new JPanel();
  * PSwing swing = new PSwing(panel);
@@ -171,8 +171,7 @@
  * newChild.setDoubleBuffered(true);
  * panel.add(newChild);
  *
- * - *

+ * *

* NOTE: PSwing cannot be correctly interacted with through multiple cameras. * There is no support for it yet. @@ -187,12 +186,11 @@ * Piccolo. A future release of Piccolo will provide support for long term * persistence. *

- * + * * @author Sam R. Reid * @author Chris Malley (cmalley@pixelzoom.com) * @author Benjamin B. Bederson * @author Lance E. Good - * */ public class PSwing extends PNode implements Serializable, PropertyChangeListener { /** Default serial version UID. */ @@ -394,7 +392,7 @@ /** * Paints the PSwing on the specified renderContext. Also determines if * the Swing component should be rendered normally or as a filled rectangle (greeking). - *

+ *

* The transform, clip, and composite will be set appropriately when this * object is rendered. It is up to this object to restore the transform, * clip, and composite of the Graphics2D if this node changes any of them. diff --git a/extras/src/main/java/org/piccolo2d/extras/pswing/PSwingMouseEvent.java b/extras/src/main/java/org/piccolo2d/extras/pswing/PSwingMouseEvent.java index 822964e..c12b74b 100644 --- a/extras/src/main/java/org/piccolo2d/extras/pswing/PSwingMouseEvent.java +++ b/extras/src/main/java/org/piccolo2d/extras/pswing/PSwingMouseEvent.java @@ -56,7 +56,6 @@ * * * - *

*

* A PMouseEvent object is passed to every PMouseListener or * PMouseAdapter object which registered to receive the @@ -64,14 +63,12 @@ * addMouseListener method. (PMouseAdapter objects * implement the PMouseListener interface.) Each such listener * object gets a PMouseEvent containing the mouse event. - *

*

* Warning: Serialized objects of this class will not be compatible with * future Piccolo2d releases. The current serialization support is appropriate * for short term storage or RMI between applications running the same version * of Piccolo2d. A future release of Piccolo2d will provide support for long * term persistence. - *

* * @author Benjamin B. Bederson * @author Sam R. Reid @@ -282,4 +279,4 @@ public MouseEvent asMouseEvent() { return this; } -} \ No newline at end of file +} diff --git a/extras/src/main/java/org/piccolo2d/extras/pswing/PSwingMouseMotionEvent.java b/extras/src/main/java/org/piccolo2d/extras/pswing/PSwingMouseMotionEvent.java index ef887ec..717defb 100644 --- a/extras/src/main/java/org/piccolo2d/extras/pswing/PSwingMouseMotionEvent.java +++ b/extras/src/main/java/org/piccolo2d/extras/pswing/PSwingMouseMotionEvent.java @@ -46,7 +46,6 @@ *
  • the mouse is dragged * * - *

    *

    * A PMouseEvent object is passed to every PMouseMotionListener or * PMouseMotionAdapter object which registered to receive mouse @@ -54,14 +53,12 @@ * method. (PMouseMotionAdapter objects implement the * PMouseMotionListener interface.) Each such listener object gets * a PMouseEvent containing the mouse motion event. - *

    *

    * Warning: Serialized objects of this class will not be compatible with * future Piccolo releases. The current serialization support is appropriate for * short term storage or RMI between applications running the same version of * Piccolo. A future release of Piccolo will provide support for long term * persistence. - *

    * * @author Benjamin B. Bederson * @author Sam R. Reid @@ -105,4 +102,4 @@ } } -} \ No newline at end of file +} diff --git a/extras/src/main/java/org/piccolo2d/extras/pswing/PSwingMouseWheelEvent.java b/extras/src/main/java/org/piccolo2d/extras/pswing/PSwingMouseWheelEvent.java index 75c5b31..9180977 100644 --- a/extras/src/main/java/org/piccolo2d/extras/pswing/PSwingMouseWheelEvent.java +++ b/extras/src/main/java/org/piccolo2d/extras/pswing/PSwingMouseWheelEvent.java @@ -42,7 +42,7 @@ /** * PMouseMotionEvent is an event which indicates that a mouse motion * action occurred in a node. - *

    + *

    * This low-level event is generated by a node object for: *

    * - *

    + *

    * A PMouseEvent object is passed to every PMouseMotionListener or * PMouseMotionAdapter object which registered to receive mouse * motion events using the component's addMouseMotionListener * method. (PMouseMotionAdapter objects implement the * PMouseMotionListener interface.) Each such listener object gets * a PMouseEvent containing the mouse motion event. - *

    - *

    + *

    * Warning: Serialized objects of this class will not be compatible with * future Piccolo releases. The current serialization support is appropriate for * short term storage or RMI between applications running the same version of @@ -239,4 +238,4 @@ public MouseEvent asMouseEvent() { return this; } -} \ No newline at end of file +} diff --git a/extras/src/main/java/org/piccolo2d/extras/swing/PScrollDirector.java b/extras/src/main/java/org/piccolo2d/extras/swing/PScrollDirector.java index 66930d2..36f80b8 100644 --- a/extras/src/main/java/org/piccolo2d/extras/swing/PScrollDirector.java +++ b/extras/src/main/java/org/piccolo2d/extras/swing/PScrollDirector.java @@ -37,7 +37,7 @@ /** * The interface an application can implement to control scrolling in a - * PScrollPane->PViewport->ZCanvas component hierarchy. + * PScrollPane to PViewport to PCanvas component hierarchy. * * @see PDefaultScrollDirector * @author Lance Good diff --git a/extras/src/main/java/org/piccolo2d/extras/util/LineShape.java b/extras/src/main/java/org/piccolo2d/extras/util/LineShape.java index 492f78f..912a168 100644 --- a/extras/src/main/java/org/piccolo2d/extras/util/LineShape.java +++ b/extras/src/main/java/org/piccolo2d/extras/util/LineShape.java @@ -301,8 +301,8 @@ } /** - * Returns true if the two segments defined by (x1,y1)->(x2,y2) and - * (x3,y3)->(x4,y4) intersect. Optional fields allow for consideration of + * Returns true if the two segments defined by (x1,y1) → (x2,y2) and + * (x3,y3) → (x4,y4) intersect. Optional fields allow for consideration of * extending the segments to infinity at either end. * * @param x1 segment 1's start x component diff --git a/extras/src/main/java/org/piccolo2d/extras/util/PSemanticStroke.java b/extras/src/main/java/org/piccolo2d/extras/util/PSemanticStroke.java index 200b3f5..7da41c4 100644 --- a/extras/src/main/java/org/piccolo2d/extras/util/PSemanticStroke.java +++ b/extras/src/main/java/org/piccolo2d/extras/util/PSemanticStroke.java @@ -57,7 +57,7 @@ * Ask {@link #getActiveScale()}, call {@link #newStroke(float)} if * necessary and delegate to {@link Stroke#createStrokedShape(Shape)}. * - * @param s + * @param s shape */ public Shape createStrokedShape(final Shape s) { final float currentScale = getActiveScale(); @@ -99,6 +99,8 @@ /** * Detect the current scale. Made protected to enable custom * re-implementations. + * + * @return the current scale */ protected float getActiveScale() { if (PPickPath.CURRENT_PICK_PATH != null) { @@ -122,6 +124,9 @@ /** * Factory to create a new internal stroke delegate. Made protected to * enable custom re-implementations. + * + * @param activeScale active scale + * @return a new internal stroke delegate */ protected abstract Stroke newStroke(final float activeScale); diff --git a/swt-examples/src/main/java/org/piccolo2d/extras/swt/examples/FillShapeExample.java b/swt-examples/src/main/java/org/piccolo2d/extras/swt/examples/FillShapeExample.java index 7210940..926c819 100644 --- a/swt-examples/src/main/java/org/piccolo2d/extras/swt/examples/FillShapeExample.java +++ b/swt-examples/src/main/java/org/piccolo2d/extras/swt/examples/FillShapeExample.java @@ -43,7 +43,7 @@ * Example demonstrating issue 187, general shapes are not filled * correctly under SWT. * - * See {@link http://code.google.com/p/piccolo2d/issues/detail?id=187} + * See https://github.com/piccolo2d/piccolo2d.java/issues/187. */ public class FillShapeExample {