update to the latest

taweili · Feb 8, 2012 · 02fcb96 · 02fcb96
2 parents 8fa8902 + 3d0f10d
commit 02fcb96
Show file tree

Hide file tree

Showing 42 changed files with 663 additions and 302 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,9 @@
 build/
 target/
 .DS_Store
+.classpath
+.idea
+.project
+.settings
+openblocks.iml
+
diff --git a/README.md b/README.md
@@ -26,3 +26,13 @@ Done:
 * remove dependency to TableLayout, which doesn't appear to be actively maintained,
   and really not even used in a very complex manner
 
+Contributors:
+-------------
+
+In order of first appearance on commit logs:
+
+* The original MIT team: Eric Klopfer, Daniel Wendel, Ricarose Roque, Corey McCaffrey, Lunduo Ye, Aidan Ho, Brett Warne, Xudan Liu, Hout Nga
+* Mikael Gueck (https://github.com/mikaelhg)
+* David Li (https://github.com/taweili)
+* Philippe Cade (https://github.com/philippecade)
+* Tony Graham / MenteaXML (https://github.com/MenteaXML)
diff --git a/pom.xml b/pom.xml
@@ -1,71 +1,150 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-    <properties>
-        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    </properties>
-    <modelVersion>4.0.0</modelVersion>
-    <groupId>edu.mit</groupId>
-    <artifactId>openblocks</artifactId>
-    <packaging>jar</packaging>
-    <version>1.0-20110819</version>
-    <name>openblocks</name>
-    <url>https://github.com/mikaelhg/openblocks</url>
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-compiler-plugin</artifactId>
-                <version>2.3.2</version>
-                <configuration>
-                    <source>1.5</source>
-                    <target>1.5</target>
-                </configuration>
-            </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-jar-plugin</artifactId>
-                <version>2.3.1</version>
-                <configuration>
-                    <archive>
-                        <manifest>
-                            <mainClass>edu.mit.blocks.controller.WorkspaceController</mainClass>
-                        </manifest>
-                    </archive>
-                </configuration>
-            </plugin>
-            <plugin>
-                <artifactId>maven-assembly-plugin</artifactId>
-                <configuration>
-                    <descriptorRefs>
-                        <descriptorRef>jar-with-dependencies</descriptorRef>
-                    </descriptorRefs>
-                    <archive>
-                        <manifest>
-                            <mainClass>edu.mit.blocks.controller.WorkspaceController</mainClass>
-                        </manifest>
-                    </archive>
-                </configuration>
-            </plugin>
-        </plugins>
-    </build>
-    <dependencies>
-        <dependency>
-            <groupId>jfree</groupId>
-            <artifactId>jcommon</artifactId>
-            <version>1.0.15</version>
-        </dependency>
-        <dependency>
-            <groupId>jfree</groupId>
-            <artifactId>jfreechart</artifactId>
-            <version>1.0.12</version>
-        </dependency>
-        <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
-            <version>4.8.1</version>
-            <scope>test</scope>
-        </dependency>
-    </dependencies>
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>edu.mit</groupId>
+  <artifactId>openblocks</artifactId>
+  <packaging>jar</packaging>
+  <version>1.0-SNAPSHOT</version>
+  <name>openblocks</name>
+  <url>https://github.com/mikaelhg/openblocks</url>
+
+  <properties>
+    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <version>2.3.2</version>
+        <configuration>
+          <source>1.6</source>
+          <target>1.6</target>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jar-plugin</artifactId>
+        <version>2.3.1</version>
+        <configuration>
+          <archive>
+            <manifest>
+              <mainClass>edu.mit.blocks.controller.WorkspaceController</mainClass>
+            </manifest>
+          </archive>
+        </configuration>
+      </plugin>
+      <plugin>
+        <artifactId>maven-assembly-plugin</artifactId>
+        <configuration>
+          <descriptorRefs>
+            <descriptorRef>jar-with-dependencies</descriptorRef>
+          </descriptorRefs>
+          <archive>
+            <manifest>
+              <mainClass>edu.mit.blocks.controller.WorkspaceController</mainClass>
+            </manifest>
+          </archive>
+        </configuration>
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.8</version>
+        <configuration>
+          <show>private</show>
+          <tags>
+            <tag>
+              <name>effects</name>
+              <placement>a</placement>
+              <head>Effects:</head>
+            </tag>
+            <tag>
+              <name>modifies</name>
+              <placement>a</placement>
+              <head>Modifies:</head>
+            </tag>
+            <tag>
+              <name>overrides</name>
+              <placement>a</placement>
+              <head>Overrides:</head>
+            </tag>
+            <tag>
+              <name>requires</name>
+              <placement>a</placement>
+              <head>Requires:</head>
+            </tag>
+            <tag>
+              <name>specfield</name>
+              <placement>a</placement>
+              <head>Spec field:</head>
+            </tag>
+          </tags>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.8</version>
+        <configuration>
+          <show>public</show>
+          <tags>
+            <tag>
+              <name>effects</name>
+              <placement>a</placement>
+              <head>Effects:</head>
+            </tag>
+            <tag>
+              <name>modifies</name>
+              <placement>a</placement>
+              <head>Modifies:</head>
+            </tag>
+            <tag>
+              <name>overrides</name>
+              <placement>a</placement>
+              <head>Overrides:</head>
+            </tag>
+            <tag>
+              <name>requires</name>
+              <placement>a</placement>
+              <head>Requires:</head>
+            </tag>
+            <tag>
+              <name>specfield</name>
+              <placement>a</placement>
+              <head>Spec field:</head>
+            </tag>
+          </tags>
+        </configuration>
+      </plugin>
+    </plugins>
+  </reporting>
+
+  <dependencies>
+    <dependency>
+      <groupId>jfree</groupId>
+      <artifactId>jcommon</artifactId>
+      <version>1.0.16</version>
+    </dependency>
+    <dependency>
+      <groupId>jfree</groupId>
+      <artifactId>jfreechart</artifactId>
+      <version>1.0.13</version>
+    </dependency>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.10</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
 </project>
diff --git a/src/main/java/edu/mit/blocks/codeblocks/Block.java b/src/main/java/edu/mit/blocks/codeblocks/Block.java
@@ -1145,7 +1145,7 @@ public String getLabelSuffix() {
      * Also known as the block tool tip, or block description.
      * If no descriptions exists, return null.
      * FORWARDED FROM BLOCK GENUS
-     * @returns the String block text description of this
+     * @return the String block text description of this
      * 			or NULL if none exists.
      */
     public String getBlockDescription() {
@@ -1156,7 +1156,7 @@ public String getBlockDescription() {
      * Returns the the argument description at index i.
      * If the index is out of bounds or if no argument
      * description exists for arguemnt at index i , return null.
-     * @returns the String argument descriptions of this or NULL.
+     * @return the String argument descriptions of this or NULL.
      */
     public String getArgumentDescription(int index) {
         if (index < argumentDescriptions.size() && index >= 0) {
@@ -1217,7 +1217,7 @@ public BlockConnector getInitPlug() {
     }
 
     /**
-     * @returns current information about block
+     * @return current information about block
      */
     public String toString() {
         return "Block " + blockID + ": " + label + " with sockets: " + sockets + " and plug: " + plug + " before: " + before + " after: " + after;

diff --git a/src/main/java/edu/mit/blocks/codeblocks/BlockConnector.java b/src/main/java/edu/mit/blocks/codeblocks/BlockConnector.java
@@ -104,7 +104,6 @@ public BlockConnector(Workspace workspace, String label, String kind, boolean is
     /**
      * Constucts a new <code>BlockConnector</code> by copying the connector information
      * from the specified con.  Copies the con's connector label and kind.
-     * @param workspace The workspace this connector is created in 
      * @param con the BlockConnector to copy from
      */
     public BlockConnector(BlockConnector con) {

diff --git a/src/main/java/edu/mit/blocks/codeblocks/BlockConnectorShape.java b/src/main/java/edu/mit/blocks/codeblocks/BlockConnectorShape.java
@@ -306,7 +306,7 @@ public Point2D addDataPlugUp(GeneralPath blockPath, String connectionShape, bool
      * _lineTo and _curveTo are relative to the starting point of the the data connection to be drawn.
      * 
      * @param blockPath is the current GeneralPath to be appended
-     * @param socketShape is the integer representing the kind and style of socket to be drawn
+     * @param connectionShape is the integer representing the kind and style of connection to be drawn
      * @param startFromTop true if end of the current generalPath is at the top of the data connection to be drawn
      * @param convexRight true if curve drawn points to the right
      */

diff --git a/src/main/java/edu/mit/blocks/codeblocks/BlockGenus.java b/src/main/java/edu/mit/blocks/codeblocks/BlockGenus.java
@@ -354,7 +354,7 @@ public String getLabelSuffix() {
      * Returns the String block text description of this.
      * Also known as the block tool tip, or block description.
      * If no descriptions exists, return null.
-     * @returns the String block text description of this or NULL.
+     * @return the String block text description of this or NULL.
      */
     public String getBlockDescription() {
         return blockDescription;
@@ -369,7 +369,7 @@ public String getBlockDescription() {
      * An existing description may not have an existing
      * socket (in the case of expandable socket sizes).
      * If no descriptions exists, return null.
-     * @returns the String argument descriptions of this or NULL.
+     * @return the String argument descriptions of this or NULL.
      */
     public Iterable<String> getInitialArgumentDescriptions() {
         return Collections.unmodifiableList(argumentDescriptions);

diff --git a/src/main/java/edu/mit/blocks/codeblocks/BlockStub.java b/src/main/java/edu/mit/blocks/codeblocks/BlockStub.java
@@ -498,7 +498,7 @@ public Color getColor() {
     }
 
     /**
-     * @returns current information about block
+     * @return current information about block
      */
     public String toString() {
         return "Block Stub +" + getBlockID() + ": " + getBlockLabel() + " with sockets: " + getSockets() + " and plug: " + getPlug();

diff --git a/src/main/java/edu/mit/blocks/codeblocks/CustomBlockShapeSet.java b/src/main/java/edu/mit/blocks/codeblocks/CustomBlockShapeSet.java
@@ -34,7 +34,7 @@ public class CustomBlockShape {
      * Checks if the given block is a "special shape" that has custom dimensions.
      * CornerPoints is an array with array order Point2D topLeftCorner, Point2D topRightCorner,
      * 											Point2D botLeftCorner, Point2D botRightCorner.
-     * @returns if a matching customBlockShape was found that corresponds to the given block.
+     * @return if a matching customBlockShape was found that corresponds to the given block.
      * @modifies the array of cornerPoints if method returns true
      */
     public boolean checkCustomShapes(Block b, Point2D[] cornerPoints, int labelsWidth, int totalSocketHeight) {

diff --git a/src/main/java/edu/mit/blocks/codeblockutil/CButton.java b/src/main/java/edu/mit/blocks/codeblockutil/CButton.java
@@ -103,7 +103,7 @@ public CButton(Color buttonColor, Color selectedColor, String text) {
      * @param selectedColor
      *
      * @requires buttonColor, selectedColor != null
-     * @modfidies this.buttonColor && this.seletedColor
+     * @modifies this.buttonColor && this.seletedColor
      * @effects change button coloring to match to inputs
      */
     public void setLighting(Color buttonColor, Color selectedColor) {

diff --git a/src/main/java/edu/mit/blocks/codeblockutil/CGlassScrollPane.java b/src/main/java/edu/mit/blocks/codeblockutil/CGlassScrollPane.java
@@ -231,31 +231,31 @@ public void repositionComponents() {
     }
 
     /**
-     * @ovverride CScrollPane.getVerticalModel
+     * @overrides CScrollPane.getVerticalModel
      */
     @Override
     public BoundedRangeModel getVerticalModel() {
         return scrollviewport.getVerticalScrollBar().getModel();
     }
 
     /**
-     * @ovverride CScrollPane.getHorizontalModel
+     * @overrides CScrollPane.getHorizontalModel
      */
     @Override
     public BoundedRangeModel getHorizontalModel() {
         return scrollviewport.getHorizontalScrollBar().getModel();
     }
 
     /**
-     * @ovverride CScrollPane.scrollRectToVisible
+     * @overrides CScrollPane.scrollRectToVisible
      */
     @Override
     public void scrollRectToVisible(Rectangle contentRect) {
         scrollviewport.getViewport().scrollRectToVisible(contentRect);
     }
 
     /**
-     * @ovverride CScrollPane.setScrollingUnit
+     * @overrides CScrollPane.setScrollingUnit
      */
     @Override
     public void setScrollingUnit(int x) {
@@ -264,7 +264,7 @@ public void setScrollingUnit(int x) {
     }
 
     /**
-     * @override CScrollPane.mouseWheelMoved
+     * @overrides CScrollPane.mouseWheelMoved
      * TODO: This is duplicate code (In Hover, Glass, and Tackless ScollPanes)
      * For MACs only: Horizontal scroll events are delivered
      * to JScrollPanes as Shift+ScrollWheel events AUTOMATICALLY,