Revision: 751
Author: heuermh
Date: Mon Oct 19 19:51:21 2009
Log: more style and javadoc fixes
http://code.google.com/p/piccolo2d/source/detail?r=751

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/PCamera.java        
 
Mon Oct 19 19:39:23 2009
+++  
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PCamera.java        
 
Mon Oct 19 19:51:21 2009
@@ -58,7 +58,7 @@
   * and scaling this view transform is how zooming and panning are  
implemented.
   * <p>
   * Cameras are also the point through which all PInputEvents enter  
Piccolo. The
- * canvas coordinate system, and the local coordinate system of the topmost
+ * canvas coordinate system and the local coordinate system of the topmost
   * camera should always be the same.
   * </p>
   *
@@ -163,7 +163,7 @@
       * Set the component for this camera to <code>component</code>. The
       * component, if non-null, receives repaint notification from this  
camera.
       *
-     * @param component the component for this camera
+     * @param component component for this camera
       */
      public void setComponent(final PComponent component) {
          this.component = component;
@@ -174,8 +174,8 @@
       * Repaint this camera and forward the repaint request to the component
       * for this camera, if it is non-null.
       *
-     * @param localBounds the area that requires repainting
-     * @param sourceNode the node from which the repaint message  
originates, may
+     * @param localBounds bounds in local coordinates that requires  
repainting
+     * @param sourceNode node from which the repaint message originates,  
may
       *    be the camera itself
       */
      public void repaintFrom(final PBounds localBounds, final PNode  
sourceNode) {
@@ -196,8 +196,8 @@
       * in Piccolo2D this one must not modify the <code>viewBounds</code>
       * parameter.
       *
-     * @param viewBounds bounds of the region needing painting
-     * @param repaintedLayer the layer dispatching the repaint notification
+     * @param viewBounds bounds in view coordinates that requires  
repainting
+     * @param repaintedLayer layer dispatching the repaint notification
       */
      public void repaintFromLayer(final PBounds viewBounds, final PLayer  
repaintedLayer) {
          TEMP_REPAINT_RECT.setRect(viewBounds);
@@ -211,8 +211,8 @@
      /**
       * @deprecated by {...@link #repaintFromLayer(PBounds, PLayer)}. Will be  
removed
       *    in version 2.0.
-     * @param viewBounds bounds of the region needing painting
-     * @param repaintedLayer the layer dispatching the repaint notification
+     * @param viewBounds bounds in view coordinates that requires  
repainting
+     * @param repaintedLayer layer dispatching the repaint notification
       */
      public void repaintFromLayer(final PBounds viewBounds, final PNode  
repaintedLayer) {
          if (repaintedLayer instanceof PLayer) {
@@ -244,7 +244,7 @@
      /**
       * Return the layer at the specified position in the list of layers  
viewed by this camera.
       *
-     * @param index the index of the layer to return
+     * @param index index of the layer to return
       * @return the layer at the specified position in the list of layers  
viewed by this camera
       * @throws IndexOutOfBoundsException if the specified index is out of  
range
       *    (<code>index &lt; 0 || index &gt;= getLayerCount()</code>)
@@ -490,6 +490,9 @@
       * picked all of the layers in the list of layers viewed by this  
camera are
       * given a chance to be picked.
       * </p>
+     *
+     * @return true if any of the layers in the list of layers viewed by  
this
+     *    camera were picked
       */
      protected boolean pickAfterChildren(final PPickPath pickPath) {
          if (intersects(pickPath.getPickBounds())) {

--~--~---------~--~----~------------~-------~--~----~
Piccolo2D Developers Group: http://groups.google.com/group/piccolo2d-dev?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to