[piccolo2d-dev] [piccolo2d] r750 committed - more style and javadoc fixes

[codesite-noreply]

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

Modified:
  /piccolo2d.java/trunk/core/src/build/conf/checkstyle.xml
  /piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PCamera.java

=======================================
--- /piccolo2d.java/trunk/core/src/build/conf/checkstyle.xml    Mon Oct 19  
13:38:38 2009
+++ /piccolo2d.java/trunk/core/src/build/conf/checkstyle.xml    Mon Oct 19  
19:39:23 2009
@@ -46,7 +46,8 @@
          <!-- Checks for Javadoc comments.                     -->
          <!-- See http://checkstyle.sf.net/config_javadoc.html -->
          <module name="JavadocMethod">
-               <property name="scope" value="protected"/>
+               <property name="scope" value="protected"/>
+               <property name="allowUndeclaredRTE" value="true"/>
          </module>
          <module name="JavadocType">
                <property name="scope" value="public"/>
=======================================
---  
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PCamera.java        
 
Mon Oct 19 19:25:58 2009
+++  
/piccolo2d.java/trunk/core/src/main/java/edu/umd/cs/piccolo/PCamera.java        
 
Mon Oct 19 19:39:23 2009
@@ -209,8 +209,10 @@
      }

      /**
-     * @deprecated by {...@link repaintFromLayer(PBounds, PLayer)}. Will be  
removed
+     * @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
       */
      public void repaintFromLayer(final PBounds viewBounds, final PNode  
repaintedLayer) {
          if (repaintedLayer instanceof PLayer) {
@@ -245,7 +247,7 @@
       * @param index the 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>index &lt; 0 || index &gt;= getLayerCount()</code>)
       */
      public PLayer getLayer(final int index) {
          return (PLayer) layers.get(index);
@@ -282,7 +284,7 @@
       * @param index index at which the specified layer is to be inserted
       * @param layer layer to add
       * @throws IndexOutOfBoundsException if the specified index is out of  
range
-     *    (<code>index &lt; 0 || index &gt;= getLayerCount())
+     *    (<code>index &lt; 0 || index &gt;= getLayerCount()</code>)
       */
      public void addLayer(final int index, final PLayer layer) {
          layers.add(index, layer);
@@ -314,7 +316,7 @@
       * @param index index of the layer to remove
       * @return the layer previously at the specified position
       * @throws IndexOutOfBoundsException if the specified index is out of  
range
-     *    (<code>index &lt; 0 || index &gt;= getLayerCount())
+     *    (<code>index &lt; 0 || index &gt;= getLayerCount()</code>)
       */
      public PLayer removeLayer(final int index) {
          final PLayer layer = (PLayer) layers.remove(index);

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