documentation for printers

hatzav-ox · Nov 13, 2016 · 8c46e13 · 8c46e13
1 parent 71e6b66
commit 8c46e13
Show file tree

Hide file tree

Showing 9 changed files with 45 additions and 20 deletions.
diff --git a/...ava/fizzbuzz/packagenamingpackage/impl/parameters/DefaultFizzBuzzUpperLimitParameter.java b/...ava/fizzbuzz/packagenamingpackage/impl/parameters/DefaultFizzBuzzUpperLimitParameter.java
@@ -20,7 +20,6 @@ public DefaultFizzBuzzUpperLimitParameter() {
 
 	/**
 	 * @param fizzBuzzUpperLimitParameterValue int
-	 * @return
      */
 	public DefaultFizzBuzzUpperLimitParameter(final int fizzBuzzUpperLimitParameterValue) {
 		super();

diff --git a/...seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/BuzzPrinter.java b/...seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/BuzzPrinter.java
@@ -7,13 +7,16 @@
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.strategies.adapters.FizzBuzzOutputStrategyToFizzBuzzExceptionSafeOutputStrategyAdapter;
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.stringreturners.BuzzStringReturner;
 
+/**
+ * BuzzPrinter
+ */
 @Service
 public class BuzzPrinter {
 
 	private final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory;
 
 	/**
-	 * @param _systemOutFizzBuzzOutputStrategyFactory
+	 * @param _systemOutFizzBuzzOutputStrategyFactory SystemOutFizzBuzzOutputStrategyFactory
      */
 	@Autowired
 	public BuzzPrinter(final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory) {
@@ -22,7 +25,7 @@ public BuzzPrinter(final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBu
 	}
 
 	/**
-	 * @return
+	 * @return void
 	 */
 	public void printBuzz() {
 		final BuzzStringReturner myBuzzStringReturner = new BuzzStringReturner();

diff --git a/...scompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/BuzzStringPrinter.java b/...scompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/BuzzStringPrinter.java
@@ -9,6 +9,9 @@
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.printers.StringPrinter;
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.stringreturners.StringStringReturner;
 
+/**
+ * Printer for BuzzString
+ */
 @Service
 public class BuzzStringPrinter implements StringPrinter {
 
@@ -29,7 +32,7 @@ public BuzzStringPrinter(final BuzzStringReturnerFactory _buzzStringReturnerFact
 	}
 
 	/**
-	 * @return
+	 * @return void
 	 */
 	public void print() {
 		final StringStringReturner myBuzzStringReturner = this._buzzStringReturnerFactory

diff --git a/...seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/FizzPrinter.java b/...seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/FizzPrinter.java
@@ -7,13 +7,16 @@
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.strategies.adapters.FizzBuzzOutputStrategyToFizzBuzzExceptionSafeOutputStrategyAdapter;
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.stringreturners.FizzStringReturner;
 
+/**
+ * Printer for Fizz
+ */
 @Service
 public class FizzPrinter {
 
 	private final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory;
 
 	/**
-	 * @param _systemOutFizzBuzzOutputStrategyFactory
+	 * @param _systemOutFizzBuzzOutputStrategyFactory SystemOutFizzBuzzOutputStrategyFactory
      */
 	@Autowired
 	public FizzPrinter(final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory) {
@@ -22,7 +25,7 @@ public FizzPrinter(final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBu
 	}
 
 	/**
-	 * @return
+	 * @return void
 	 */
 	public void printFizz() {
 		final FizzStringReturner myFizzStringReturner = new FizzStringReturner();

diff --git a/...scompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/FizzStringPrinter.java b/...scompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/FizzStringPrinter.java
@@ -9,6 +9,9 @@
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.printers.StringPrinter;
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.stringreturners.StringStringReturner;
 
+/**
+ * Printer for FizzString
+ */
 @Service
 public class FizzStringPrinter implements StringPrinter {
 
@@ -17,8 +20,8 @@ public class FizzStringPrinter implements StringPrinter {
 	private final FizzStringReturnerFactory _fizzStringReturnerFactory;
 
 	/**
-	 * @param _fizzStringReturnerFactory
-	 * @param _systemOutFizzBuzzOutputStrategyFactory
+	 * @param _fizzStringReturnerFactory FizzStringReturnerFactory
+	 * @param _systemOutFizzBuzzOutputStrategyFactory SystemOutFizzBuzzOutputStrategyFactory
      */
 	@Autowired
 	public FizzStringPrinter(final FizzStringReturnerFactory _fizzStringReturnerFactory,
@@ -29,7 +32,7 @@ public FizzStringPrinter(final FizzStringReturnerFactory _fizzStringReturnerFact
 	}
 
 	/**
-	 * @return
+	 * @return void
 	 */
 	public void print() {
 		final StringStringReturner myFizzStringReturner = this._fizzStringReturnerFactory

diff --git a/...pany/business/java/fizzbuzz/packagenamingpackage/impl/printers/IntegerIntegerPrinter.java b/...pany/business/java/fizzbuzz/packagenamingpackage/impl/printers/IntegerIntegerPrinter.java
@@ -9,6 +9,9 @@
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.printers.IntegerPrinter;
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.stringreturners.IntegerStringReturner;
 
+/**
+ * Printer for IntegerInteger
+ */
 @Service
 public class IntegerIntegerPrinter implements IntegerPrinter {
 
@@ -17,8 +20,8 @@ public class IntegerIntegerPrinter implements IntegerPrinter {
 	private final IntegerIntegerStringReturnerFactory _integerIntegerStringReturnerFactory;
 
 	/**
-	 * @param _integerIntegerStringReturnerFactory
-	 * @param _systemOutFizzBuzzOutputStrategyFactory
+	 * @param _integerIntegerStringReturnerFactory IntegerIntegerStringReturnerFactory
+	 * @param _systemOutFizzBuzzOutputStrategyFactory SystemOutFizzBuzzOutputStrategyFactory
      */
 	@Autowired
 	public IntegerIntegerPrinter(final IntegerIntegerStringReturnerFactory _integerIntegerStringReturnerFactory,
@@ -28,6 +31,9 @@ public IntegerIntegerPrinter(final IntegerIntegerStringReturnerFactory _integerI
 		this._systemOutFizzBuzzOutputStrategyFactory = _systemOutFizzBuzzOutputStrategyFactory;
 	}
 
+	/**
+	 * @param theInteger
+     */
 	public void printInteger(final int theInteger) {
 		final IntegerStringReturner myIntegerStringReturner =
 				this._integerIntegerStringReturnerFactory.createIntegerStringReturner();
@@ -40,7 +46,7 @@ public void printInteger(final int theInteger) {
 	}
 
 	/**
-	 * @return
+	 * @return void
 	 */
 	@Override
 	public void print() {

diff --git a/...iouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/IntegerPrinter.java b/...iouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/IntegerPrinter.java
@@ -8,13 +8,16 @@
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.stringreturners.IntegerIntegerStringReturner;
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.stringreturners.IntegerStringReturner;
 
+/**
+ * IntegerPrinter
+ */
 @Service
 public class IntegerPrinter {
 
 	private final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory;
 
 	/**
-	 * @param _systemOutFizzBuzzOutputStrategyFactory
+	 * @param _systemOutFizzBuzzOutputStrategyFactory SystemOutFizzBuzzOutputStrategyFactory
      */
 	@Autowired
 	public IntegerPrinter(final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory) {
@@ -23,8 +26,7 @@ public IntegerPrinter(final SystemOutFizzBuzzOutputStrategyFactory _systemOutFiz
 	}
 
 	/**
-	 * @param theInteger
-	 * @return
+	 * @param theInteger int
      */
 	public void printInteger(final int theInteger) {
 		final IntegerStringReturner myIntegerIntegerStringReturner = new IntegerIntegerStringReturner();

diff --git a/...iouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/NewLinePrinter.java b/...iouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/NewLinePrinter.java
@@ -7,13 +7,16 @@
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.strategies.adapters.FizzBuzzOutputStrategyToFizzBuzzExceptionSafeOutputStrategyAdapter;
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.stringreturners.NewLineStringReturner;
 
+/**
+ * Printer for NewLine
+ */
 @Service
 public class NewLinePrinter {
 
 	private final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory;
 
 	/**
-	 * @param _systemOutFizzBuzzOutputStrategyFactory
+	 * @param _systemOutFizzBuzzOutputStrategyFactory SystemOutFizzBuzzOutputStrategyFactory
      */
 	@Autowired
 	public NewLinePrinter(final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory) {

diff --git a/...mpany/business/java/fizzbuzz/packagenamingpackage/impl/printers/NewLineStringPrinter.java b/...mpany/business/java/fizzbuzz/packagenamingpackage/impl/printers/NewLineStringPrinter.java
@@ -9,6 +9,9 @@
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.printers.StringPrinter;
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.stringreturners.StringStringReturner;
 
+/**
+ * Printer for NewLineString
+ */
 @Service
 public class NewLineStringPrinter implements StringPrinter {
 
@@ -17,8 +20,8 @@ public class NewLineStringPrinter implements StringPrinter {
 	private final NewLineStringReturnerFactory _newLineStringReturnerFactory;
 
 	/**
-	 * @param _newLineStringReturnerFactory
-	 * @param _systemOutFizzBuzzOutputStrategyFactory
+	 * @param _newLineStringReturnerFactory NewLineStringReturnerFactory
+	 * @param _systemOutFizzBuzzOutputStrategyFactory SystemOutFizzBuzzOutputStrategyFactory
      */
 	@Autowired
 	public NewLineStringPrinter(final NewLineStringReturnerFactory _newLineStringReturnerFactory,
@@ -29,7 +32,7 @@ public NewLineStringPrinter(final NewLineStringReturnerFactory _newLineStringRet
 	}
 
 	/**
-	 * @return
+	 * @return void
 	 */
 	public void print() {
 		final StringStringReturner myNewLineStringReturner = this._newLineStringReturnerFactory
@@ -43,7 +46,7 @@ public void print() {
 	}
 
 	/**
-	 * @param value
+	 * @param value Object
      */
 	@Override
 	public void printValue(final Object value) {