javadoc friendly

Author: monkstone

src/monkstone/ColorUtil.java

@@ -20,6 +20,8 @@ public class ColorUtil {
    /**
      * Returns hex long as a positive int unless greater than Integer.MAX_VALUE
      * else return the complement as a negative integer or something like that
+     * @param hexlong long
+     * @return rgb int
      */
     static final int hexLong(long hexlong) {
         long SPLIT = Integer.MAX_VALUE + 1;
@@ -32,35 +34,35 @@ static final int hexLong(long hexlong) {
 
     /**
      *
-     * @param hexstring
-     * @return
+     * @param hexstring String
+     * @return rgb int
      */
     static public int colorString(String hexstring) {
         return java.awt.Color.decode(hexstring).getRGB();
     }
 
     /**
      *
-     * @param hex
-     * @return
+     * @param hex double
+     * @return hex float
      */
     static public float colorLong(double hex) {
         return (float) hex;
     }
 
     /**
      *
-     * @param hexlong
-     * @return
+     * @param hexlong long
+     * @return hexlong int
      */
     static public int colorLong(long hexlong){
        return hexLong(hexlong);
     }
 
     /**
      *
-     * @param hex
-     * @return
+     * @param hex double
+     * @return hex float
      */
     static public float colorDouble(double hex){
        return (float)hex;

src/monkstone/MathTool.java

@@ -1,11 +1,11 @@
 /**
- * The purpose of this tool is to allow JRubyArt users to use an alternative 
+ * The purpose of this tool is to allow JRubyArt users to use an alternative
  * to processing.org map, lerp and norm methods in their sketches
- * Copyright (C) 2015 Martin Prout. This tool is free software; you can 
- * redistribute it and/or modify it under the terms of the GNU Lesser General 
+ * Copyright (C) 2015 Martin Prout. This tool is free software; you can
+ * redistribute it and/or modify it under the terms of the GNU Lesser General
  * Public License as published by the Free Software Foundation; either version
  * 2.1 of the License, or (at your option) any later version.
- * 
+ *
  * Obtain a copy of the license at http://www.gnu.org/licenses/lgpl-2.1.html
  */
 package monkstone;
@@ -29,7 +29,7 @@ public class MathTool extends RubyObject {
 
     /**
      *
-     * @param runtime
+     * @param runtime Ruby
      */
     public static void createMathTool(Ruby runtime) {
         RubyModule processing = runtime.defineModule("Processing");
@@ -39,10 +39,10 @@ public static void createMathTool(Ruby runtime) {
 
     /**
      *
-     * @param context JRuby runtime
-     * @param recv self
+     * @param context ThreadContext
+     * @param recv IRubyObject 
      * @param args array of RubyRange (must be be numeric)
-     * @return RubyFloat
+     * @return mapped value RubyFloat
      */
     @JRubyMethod(name = "map1d", rest = true, module = true)
     public static IRubyObject mapOneD(ThreadContext context, IRubyObject recv, IRubyObject[] args) {
@@ -58,10 +58,10 @@ public static IRubyObject mapOneD(ThreadContext context, IRubyObject recv, IRuby
 
     /**
      *
-     * @param context JRuby runtime
-     * @param recv self
+     * @param context ThreadContext
+     * @param recv IRubyObject 
      * @param args array of RubyRange (must be be numeric)
-     * @return RubyFloat
+     * @return mapped value RubyFloat
      */
     @JRubyMethod(name = "constrained_map", rest = true, module = true)
     public static IRubyObject constrainedMap(ThreadContext context, IRubyObject recv, IRubyObject[] args) {
@@ -82,13 +82,13 @@ public static IRubyObject constrainedMap(ThreadContext context, IRubyObject recv
         }
        return mapMt(context, value, first1, last1, first2, last2);
     }
-    
+
     /**
      *
-     * @param context JRuby runtime
-     * @param recv self
+     * @param context ThreadContext
+     * @param recv self IRubyObject
      * @param args floats as in processing map function
-     * @return RubyFloat
+     * @return mapped value RubyFloat
      */
     @JRubyMethod(name = "p5map", rest = true, module = true)
     public static IRubyObject mapProcessing(ThreadContext context, IRubyObject recv, IRubyObject[] args) {
@@ -98,15 +98,15 @@ public static IRubyObject mapProcessing(ThreadContext context, IRubyObject recv,
         double last1 = (Double) args[2].toJava(Double.class);
         double last2 = (Double) args[4].toJava(Double.class);
         return mapMt(context, value, first1, last1, first2, last2);
-    }   
-  
+    }
+
 
     /**
      * A more correct version than processing.org version
-     * @param context
-     * @param recv
+     * @param context ThreadContext
+     * @param recv self IRubyObject
      * @param args args[2] should be between 0 and 1.0 if not returns start or stop
-     * @return
+     * @return lerped value RubyFloat
      */
     @JRubyMethod(name = "lerp", rest = true, module = true)
     public static IRubyObject lerpP(ThreadContext context, IRubyObject recv, IRubyObject[] args) {
@@ -116,33 +116,33 @@ public static IRubyObject lerpP(ThreadContext context, IRubyObject recv, IRubyOb
         if (amount <= 0) return args[0];
         if (amount >= 1.0) return args[1];
         return context.getRuntime().newFloat((1 - amount) * start + (stop * amount));
-    }   
+    }
+
 
-    
     /**
      * Identical to p5map(value, low, high, 0, 1).
-     * Numbers outside of the range are not clamped to 0 and 1, 
-     * because out-of-range values are often intentional and useful. 
-     * @param context
-     * @param recv
-     * @param args
-     * @return
+     * Numbers outside of the range are not clamped to 0 and 1,
+     * because out-of-range values are often intentional and useful.
+     * @param context ThreadContext
+     * @param recv IRubyObject
+     * @param args array of args must be be numeric
+     * @return mapped value RubyFloat
      */
     @JRubyMethod(name = "norm", rest = true, module = true)
-    public static IRubyObject normP(ThreadContext context, IRubyObject recv, IRubyObject[] args) { 
+    public static IRubyObject normP(ThreadContext context, IRubyObject recv, IRubyObject[] args) {
         double value = (Double) args[0].toJava(Double.class);
         double start = (Double) args[1].toJava(Double.class);
-        double stop = (Double) args[2].toJava(Double.class);         
+        double stop = (Double) args[2].toJava(Double.class);
         return mapMt(context, value, start, stop, 0, 1.0);
     }
-    
+
     /**
      * Identical to p5map(value, low, high, 0, 1) but 'clamped'.
-     * Numbers outside of the range are clamped to 0 and 1, 
-     * @param context
-     * @param recv
-     * @param args
-     * @return
+     * Numbers outside of the range are clamped to 0 and 1,
+     * @param context ThreadContext
+     * @param recv IRubyObject
+     * @param args array of args must be be numeric
+     * @return mapped value RubyFloat
      */
     @JRubyMethod(name = "norm_strict", rest = true, module = true)
     public static IRubyObject norm_strict(ThreadContext context, IRubyObject recv, IRubyObject[] args) {
@@ -157,18 +157,18 @@ public static IRubyObject norm_strict(ThreadContext context, IRubyObject recv, I
         } else {
             return mapMt(context, value, start, stop, 0, 1.0);
         }
-    }    
-    
-    static final RubyFloat mapMt(ThreadContext context, double value, double first1, double last1, double first2, double last2) {   
+    }
+
+    static final RubyFloat mapMt(ThreadContext context, double value, double first1, double last1, double first2, double last2) {
         double result = first2 + (last2 - first2) * ((value - first1) / (last1 - first1));
         return context.getRuntime().newFloat(result);
     }
-    
+
     /**
      * Provides processing constrain method as a ruby module method
-     * @param context
-     * @param recv
-     * @param args
+     * @param context ThreadContext
+     * @param recv IRubyObject
+     * @param args array of args must be be numeric
      * @return original or limit values
      */
     @JRubyMethod(name = "constrain", rest = true, module = true)
@@ -185,12 +185,10 @@ public static IRubyObject constrainValue(ThreadContext context, IRubyObject recv
         }
     }
 
-    
-
     /**
      *
-     * @param runtime
-     * @param metaClass
+     * @param runtime Ruby
+     * @param metaClass RubyClass
      */
     public MathTool(Ruby runtime, RubyClass metaClass) {
         super(runtime, metaClass);

src/monkstone/MathToolLibrary.java

@@ -23,17 +23,16 @@ public class MathToolLibrary implements Library{
 
     /**
      *
-     * @param runtime
+     * @param runtime Ruby
      */
     public static void load(final Ruby runtime) {
         MathTool.createMathTool(runtime);
     }
 
     /**
-     *
-     * @param runtime
-     * @param wrap
-     * @throws java.io.IOException
+     * 
+     * @param runtime Ruby
+     * @param wrap boolean
      */
     @Override
     public void load(final Ruby runtime, boolean wrap) throws IOException {

src/monkstone/arcball/Arcball.java

@@ -79,7 +79,7 @@ public Arcball(PApplet parent, double center_x, double center_y, double radius)
     /**
      * Default centered arcball and half width or half height whichever smaller
      *
-     * @param parent
+     * @param parent PApplet
      *
      */
     public Arcball(PApplet parent) {
@@ -93,7 +93,7 @@ public Arcball(PApplet parent) {
     /**
      * mouse event to register
      *
-     * @param e
+     * @param e MouseEvent
      */
     public void mouseEvent(MouseEvent e) {
         int x = e.getX();
@@ -120,7 +120,7 @@ public void mouseEvent(MouseEvent e) {
     /**
      * key event to register
      *
-     * @param e
+     * @param e KeyEvent
      */
     public void keyEvent(processing.event.KeyEvent e) {
         if (e.getAction() != KeyEvent.PRESS) {
@@ -156,7 +156,7 @@ public void pre() {
      * May or may not be required for use in Web Applet it works so why worry as
      * used by Jonathan Feinberg peasycam, and that works OK
      *
-     * @param active
+     * @param active boolean
      */
     public void setActive(boolean active) {
         if (active != isActive) {
@@ -188,8 +188,8 @@ private void update() {
      * Returns either the Jvector of mouse position mapped to a sphere or the
      * constrained version (when constrained to one axis)
      *
-     * @param x
-     * @param y
+     * @param x double
+     * @param y double
      * @return mouse coordinate mapped to unit sphere
      */
     public Jvector mouse2sphere(double x, double y) {
@@ -209,9 +209,9 @@ public Jvector mouse2sphere(double x, double y) {
     /**
      * Returns the Jvector if the axis is constrained
      *
-     * @param vector
-     * @param axis
-     * @return
+     * @param vector Jvector
+     * @param axis Jvector
+     * @return constrained axis Jvector
      */
     public Jvector constrainVector(Jvector vector, Jvector axis) {
         Jvector res = vector.sub(axis.mult(axis.dot(vector)));
@@ -221,7 +221,7 @@ public Jvector constrainVector(Jvector vector, Jvector axis) {
     /**
      * Constrain rotation to this axis
      *
-     * @param axis
+     * @param axis Constrain
      */
     public void constrain(Constrain axis) {
         this.axis = axis;
@@ -230,7 +230,7 @@ public void constrain(Constrain axis) {
     /**
      * Rotate the parent sketch according to the quaternion
      *
-     * @param q
+     * @param q Quaternion
      */
     public void applyQuaternion2Matrix(Quaternion q) {
         // instead of transforming q into a matrix and applying it...
@@ -247,8 +247,8 @@ public void dispose() {
 
     /**
      *
-     * @param obj
-     * @return
+     * @param obj Object
+     * @return a boolean
      */
     @Override
     public boolean equals(Object obj) {
@@ -273,7 +273,7 @@ public boolean equals(Object obj) {
 
     /**
      *
-     * @return
+     * @return hash int
      */
     @Override
     public int hashCode() {

src/monkstone/arcball/ArcballLibrary.java

@@ -12,17 +12,16 @@ public class ArcballLibrary implements Library {
 
     /**
      *
-     * @param runtime
+     * @param runtime Ruby
      */
     public static void load(final Ruby runtime) {
         Rarcball.createArcBall(runtime);
     }  
 
     /**
      *
-     * @param runtime
-     * @param wrap
-     * @throws IOException
+     * @param runtime Ruby
+     * @param wrap boolean
      */
     @Override
     public void load(final Ruby runtime, boolean wrap) throws IOException {

src/monkstone/arcball/Constrain.java

@@ -51,7 +51,7 @@ public enum Constrain {
 
     /**
      * Numeric value of constrained axis
-     * @return
+     * @return axis int
      */
     public int index() {
         return index;