Documentation for loops, math.arithmetics, parameters

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/loop/LoopCondition.java

@@ -5,13 +5,16 @@
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.strategies.comparators.integercomparator.ThreeWayIntegerComparator;
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.strategies.comparators.integercomparator.ThreeWayIntegerComparisonResult;
 
+/**
+ * LoopCondition
+ */
 @Service
 public class LoopCondition {
 
 	/**
-	 * @param nCurrentNumber
-	 * @param nTotalCount
-     * @return
+	 * @param nCurrentNumber int
+	 * @param nTotalCount int
+     * @return boolean
      */
 	public boolean evaluateLoop(final int nCurrentNumber, final int nTotalCount) {
 		final ThreeWayIntegerComparisonResult comparisonResult = ThreeWayIntegerComparator.Compare(nCurrentNumber,

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/loop/LoopContext.java

@@ -10,7 +10,7 @@
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.loop.LoopContextStateRetrieval;
 
 /**
- *
+ * LoopContext
  */
 public final class LoopContext implements LoopContextStateManipulation, LoopContextStateRetrieval {
 
@@ -21,7 +21,7 @@ public final class LoopContext implements LoopContextStateManipulation, LoopCont
 	private int myCurrentControlParameterValue;
 
 	/**
-	 * @param nLoopControlParameterFinalValue
+	 * @param nLoopControlParameterFinalValue int
      */
 	public LoopContext(final int nLoopControlParameterFinalValue) {
 		super();

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/loop/LoopFinalizer.java

@@ -1,11 +1,14 @@
 package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.loop;
 
+/**
+ * LoopFinalizer
+ */
 public final class LoopFinalizer {
 
 	private final int nStoredLoopFinalValue;
 
 	/**
-	 * @param nLoopFinalValue
+	 * @param nLoopFinalValue int
      */
 	public LoopFinalizer(final int nLoopFinalValue) {
 		super();

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/loop/LoopInitializer.java

@@ -4,6 +4,9 @@
 
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.Constants;
 
+/**
+ * LoopInitializer
+ */
 @Service
 public class LoopInitializer {
 

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/loop/LoopRunner.java

@@ -4,16 +4,19 @@
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.loop.LoopContextStateRetrieval;
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.loop.LoopPayloadExecution;
 
+/**
+ * LoopRunner
+ */
 public final class LoopRunner {
 
 	private final LoopContextStateManipulation myStateManipulation;
 	private final LoopContextStateRetrieval myStateRetrieval;
 	private final LoopPayloadExecution myPayload;
 
 	/**
-	 * @param stateManipulation
-	 * @param stateRetrieval
-	 * @param payload
+	 * @param stateManipulation LoopContextStateManipulation
+	 * @param stateRetrieval LoopContextStateRetrieval
+	 * @param payload LoopPayloadExecution
      */
 	public LoopRunner(final LoopContextStateManipulation stateManipulation,
 			final LoopContextStateRetrieval stateRetrieval, final LoopPayloadExecution payload) {

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/loop/LoopStep.java

@@ -4,11 +4,14 @@
 
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.Constants;
 
+/**
+ * LoopStep
+ */
 @Service
 public class LoopStep {
 
 	/**
-	 * @param nCurrentNumber
+	 * @param nCurrentNumber int
 	 * @return int
      */
 	public int stepLoop(final int nCurrentNumber) {

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/math/arithmetics/IntegerDivider.java

@@ -17,8 +17,8 @@ public class IntegerDivider {
 	private final FirstIsLargerThanSecondDoubleComparator firstIsLargerThanSecondDoubleComparator;
 
 	/**
-	 * @param firstIsLargerThanSecondDoubleComparator
-	 * @param firstIsSmallerThanSecondDoubleComparator
+	 * @param firstIsLargerThanSecondDoubleComparator FirstIsLargerThanSecondDoubleComparator
+	 * @param firstIsSmallerThanSecondDoubleComparator FirstIsSmallerThanSecondDoubleComparator
      */
 	@Autowired
 	public IntegerDivider(final FirstIsLargerThanSecondDoubleComparator firstIsLargerThanSecondDoubleComparator,
@@ -29,8 +29,8 @@ public IntegerDivider(final FirstIsLargerThanSecondDoubleComparator firstIsLarge
 	}
 
 	/**
-	 * @param nFirstInteger
-	 * @param nSecondInteger
+	 * @param nFirstInteger int
+	 * @param nSecondInteger int
      * @return int
      */
 	public int divide(final int nFirstInteger, final int nSecondInteger) {

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/math/arithmetics/NumberIsMultipleOfAnotherNumberVerifier.java

@@ -7,13 +7,16 @@
 
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.strategies.comparators.integercomparator.IntegerForEqualityComparator;
 
+/**
+ *  Verifier for NumberIsMultipleOfAnotherNumber
+ */
 @Service
 public class NumberIsMultipleOfAnotherNumberVerifier {
 
 	private static IntegerDivider integerDivider;
 
 	/**
-	 * @return
+	 * @return void
 	 */
 	@PostConstruct
 	public void init() {
@@ -22,8 +25,8 @@ public void init() {
 	}
 
 	/**
-	 * @param nFirstNumber
-	 * @param nSecondNumber
+	 * @param nFirstNumber int
+	 * @param nSecondNumber int
      * @return
      */
 	public static boolean numberIsMultipleOfAnotherNumber(final int nFirstNumber, final int nSecondNumber) {

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/parameters/DefaultFizzBuzzUpperLimitParameter.java

@@ -3,20 +3,23 @@
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.Constants;
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.parameters.FizzBuzzUpperLimitParameter;
 
+/**
+ * Parameter for DefaultFizzBuzzUpperLimit
+ */
 public final class DefaultFizzBuzzUpperLimitParameter implements FizzBuzzUpperLimitParameter {
 
 	private final int fizzBuzzUpperLimitParameterValue;
 
 	/**
-	 * @return
+	 *
 	 */
 	public DefaultFizzBuzzUpperLimitParameter() {
 		super();
 		this.fizzBuzzUpperLimitParameterValue = Constants.DEFAULT_FIZZ_BUZZ_UPPER_LIMIT_PARAMETER_VALUE;
 	}
 
 	/**
-	 * @param fizzBuzzUpperLimitParameterValue
+	 * @param fizzBuzzUpperLimitParameterValue int
 	 * @return
      */
 	public DefaultFizzBuzzUpperLimitParameter(final int fizzBuzzUpperLimitParameterValue) {
@@ -25,10 +28,9 @@ public DefaultFizzBuzzUpperLimitParameter(final int fizzBuzzUpperLimitParameterV
 	}
 
 	/**
-	 * @return
+	 * @return int
      */
 	public int obtainUpperLimitValue() {
 		return this.fizzBuzzUpperLimitParameterValue;
 	}
-
 }