Fixed up all javadocs and added more verbose descriptions

Author: tmthecoder

.gradle/6.3/executionHistory/executionHistory.lock

@@ -1,3 +1,7 @@
+// Copyright 2020 Tejas Mehta <[email protected]>
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 package com.tejasmehta.OdometryCore;
 
 import com.tejasmehta.OdometryCore.localization.EncoderPositions;
@@ -6,10 +10,11 @@
 import com.tejasmehta.OdometryCore.math.CoreMath;
 
 /**
+ * The main class to wrap over all odometry calculations and providing an
+ * easy-to-use abstraction for all odometry operations, calculations, and units
  * @author Tejas Mehta
  * Made on Wednesday, November 04, 2020
  * File Name: Odometrycore
- * The main class to wrap over all odometry calculations
  */
 public class OdometryCore {
 

.gradle/6.3/fileHashes/fileHashes.lock

@@ -1,10 +1,16 @@
+// Copyright 2020 Tejas Mehta <[email protected]>
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 package com.tejasmehta.OdometryCore.localization;
 
 /****
+ * A class to unify all three encoder positions used in the core calculations
+ * for both general convenience and lack of confusion over multiple values
  * @author Tejas Mehta
  * Made on Wednesday, November 11, 2020
  * File Name: EncoderPositions
- * A class to unify all three encoder positions used in the core calculations
  */
 public class EncoderPositions {
     private final double leftPosition;

.gradle/buildOutputCleanup/buildOutputCleanup.lock

@@ -1,10 +1,16 @@
+// Copyright 2020 Tejas Mehta <[email protected]>
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 package com.tejasmehta.OdometryCore.localization;
 
 /****
+ * An enumeration for the heading unit used in the OdometryPosition to allow
+ * any users to request their degree/heading be given in the following unit(s)
  * @author Tejas Mehta
  * Made on Wednesday, November 04, 2020
  * File Name: OdometryPosition
- * An emun for the heading unit used in the OdometryPosition
  */
 public enum HeadingUnit {
     DEGREES,

.idea/OdometryCore.iml

@@ -1,10 +1,17 @@
+// Copyright 2020 Tejas Mehta <[email protected]>
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 package com.tejasmehta.OdometryCore.localization;
 
 /****
- * @author  Tejas Mehta
+ * A class to store the Odometry position in the format of an x coordinate, a
+ * a y coordinate, and an angle measure with it's heading unit, either
+ * a degree or radian. Provides convenience methods to access each value
+ * @author Tejas Mehta
  * Made on Thursday, November 12, 2020
  * File Name: EncoderTicks
- * A class to store the Odometry position in the format of an x coordinate, a y coordinate, and an angle measure
  */
 public class OdometryPosition {
     private final double x;

src/main/java/com/tejasmehta/OdometryCore/OdometryCore.java

@@ -0,0 +1,5 @@
+/**
+ * A package to handle localization of various numerical positions and
+ * angular units into an easily recognizable abstraction
+ */
+package com.tejasmehta.OdometryCore.localization;

src/main/java/com/tejasmehta/OdometryCore/localization/EncoderPositions.java

@@ -1,10 +1,15 @@
+// Copyright 2020 Tejas Mehta <[email protected]>
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 package com.tejasmehta.OdometryCore.math;
 
 /****
+ * A class to signify a cartesian coordinate and simplify polar to cartesian operations
  * @author Tejas Mehta
  * Made on Wednesday, November 04, 2020
  * File Name: LocalCoordinate
- * A class to signify a cartesian coordinate and to simplify polar and cartesian operations
  */
 public class CartesianCoordinate {
     private final double x;

src/main/java/com/tejasmehta/OdometryCore/localization/HeadingUnit.java

@@ -1,13 +1,17 @@
+// Copyright 2020 Tejas Mehta <[email protected]>
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 package com.tejasmehta.OdometryCore.math;
 
 import com.tejasmehta.OdometryCore.localization.HeadingUnit;
 import com.tejasmehta.OdometryCore.localization.OdometryPosition;
 
 /**
+ * A class to house and handle all the math methods for three wheel odometry
  * @author Tejas Mehta
  * Made on Wednesday, November 04, 2020
  * File Name: CoreMath
- * A class to house and handle all the math methods for three wheel odometry
  */
 public class CoreMath {
 

src/main/java/com/tejasmehta/OdometryCore/localization/OdometryPosition.java

@@ -1,10 +1,15 @@
+// Copyright 2020 Tejas Mehta <[email protected]>
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 package com.tejasmehta.OdometryCore.math;
 
 /****
- * @author Tejas Mehta
+ * A class to store a PolarCoordinate and simplify cartesian to polar operations
+ *  @author Tejas Mehta
  * Made on Wednesday, November 04, 2020
  * File Name: PolarCoordinate
- * A class to store a PolarCoordinate and simplify polar and cartesian operations
  */
 public class PolarCoordinate {
     private final double r;

src/main/java/com/tejasmehta/OdometryCore/localization/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * A package to handle all of the mathematical operations present within
+ * this library including odometry calculations and unit conversions
+ */
+package com.tejasmehta.OdometryCore.math;

src/main/java/com/tejasmehta/OdometryCore/math/CartesianCoordinate.java

@@ -0,0 +1,5 @@
+/**
+ * A lightweight package to provide simplified and localized core odometry
+ * motion tracking algorithms for three wheel systems
+ */
+package com.tejasmehta.OdometryCore;