Fixes some javadoc warnings (in preparation for Java 8)

src/org/daisy/dotify/common/braille/BrailleNotationConverter.java

@@ -10,7 +10,7 @@ public class BrailleNotationConverter {
 
 	/**
 	 * Creates a new converter with the specified braille cell separator.
-	 * @param separator
+	 * @param separator the separator string
 	 */
 	public BrailleNotationConverter(String separator) {
 		this.separator = separator;

src/org/daisy/dotify/common/collection/SplitList.java

@@ -40,6 +40,7 @@ public List<T> getSecondPart() {
 	 * 
 	 * @param in the original list
 	 * @param pos the position to split (must be &gt;=0 &amp;&amp; &lt;=size())
+	 * @param <T> The type of list 
 	 * @return returns the split list
 	 */
 	public static <T> SplitList<T> split(List<T> in, int pos) {

src/org/daisy/dotify/common/io/InputStreamMaker.java

@@ -15,7 +15,7 @@ public interface InputStreamMaker {
 	/**
 	 * Returns a new input stream for the source.
 	 * @return a new input stream
-	 * @throws IOException
+	 * @throws IOException if an IO-problem occurs
 	 */
 	public InputStream newInputStream() throws IOException;
 

src/org/daisy/dotify/common/io/StreamJuggler.java

@@ -19,6 +19,7 @@ public interface StreamJuggler extends Closeable {
 	 * 
 	 * @return Returns the current output stream or null if StreamJuggler has
 	 *         been closed
+	 * @throws IOException if an IO-problem occurs
 	 */
 	public OutputStream getOutputStream() throws IOException;
 

src/org/daisy/dotify/common/layout/SplitPoint.java

@@ -4,8 +4,7 @@
 import java.util.List;
 
 /**
- * Provides a data object to keep the information about a split point result.
- * 
+ * Provides a data object to keep the information about a split point result. 
  * @author Joel Håkansson
  */
 public class SplitPoint<T extends SplitPointUnit> {
@@ -19,7 +18,9 @@ public class SplitPoint<T extends SplitPointUnit> {
 	/**
 	 * Create a new SplitPoint.
 	 * @param head the part of the original SplitPointUnit list that fits within the target breakpoint 
+	 * @param supplements a list of supplement units
 	 * @param tail the part of the original SplitPointUnit list that is left
+	 * @param discarded a list of discarded units
 	 * @param hardBreak set to true if a break point could not be achieved with respect for break point boundaries 
 	 */
 	public SplitPoint(List<T> head, List<T> supplements, List<T> tail, List<T> discarded, boolean hardBreak) {

src/org/daisy/dotify/common/layout/SplitPointHandler.java

@@ -188,6 +188,7 @@ private SplitPoint<T> finalizeBreakpointTrimTail(SplitList<T> head, List<T> tail
 	 * original list. 
 	 * 
 	 * @param in the list to trim
+	 * @param <T> the type of split list
 	 * @return the list split in two parts, one with the leading skippable units, one with
 	 * the remainder
 	 */

src/org/daisy/dotify/common/text/BreakPointHandler.java

@@ -112,6 +112,7 @@ public BreakPointHandler copy() {
 	/**
 	 * Gets the next row from this BreakPointHandler
 	 * @param breakPoint the desired breakpoint for this row
+	 * @param force if force is allowed if no breakpoint is found
 	 * @return returns the next BreakPoint
 	 */
 	public BreakPoint nextRow(int breakPoint, boolean force) {

src/org/daisy/dotify/common/text/FilterLocale.java

@@ -82,7 +82,7 @@ public boolean equals(Object obj) {
 
 	/**
 	 * This locale is a subtype of the other locale
-	 * @param other
+	 * @param other the other locale
 	 * @return returns true if this locale is a subtype of the supplied locale
 	 */
 	public boolean isA(FilterLocale other) {

src/org/daisy/dotify/common/text/TextFileReader.java

@@ -81,10 +81,10 @@ public TextFileReader(InputStream is, Charset cs) {
 
 	/**
 	 * 
-	 * @param is
-	 * @param cs
-	 * @param regex
-	 * @param limit
+	 * @param is the input stream
+	 * @param cs the encoding
+	 * @param regex field delimiter expression
+	 * @param limit the maximum number of times the regex is matched
 	 */
 	public TextFileReader(InputStream is, Charset cs, String regex, int limit) {
 		if (is==null) {
@@ -103,7 +103,7 @@ private TextFileReader(Builder builder) {
 	/**
 	 * Gets the next line in the stream.
 	 * @return returns next line, or null if there are no more lines
-	 * @throws IOException
+	 * @throws IOException if an IO-problem occurs
 	 */
 	public LineData nextLine() throws IOException {
 		String line = lnr.readLine();

src/org/daisy/dotify/common/xml/XMLTools.java

@@ -129,7 +129,7 @@ private static Result toResult(Object result) throws XMLToolsException {
 	 * Returns true if the specified file is well formed XML.
 	 * @param f the file
 	 * @return returns true if the file is well formed XML, false otherwise
-	 * @throws XMLToolsException
+	 * @throws XMLToolsException if a parser cannot be configured or if parsing fails
 	 */
 	public static final boolean isWellformedXML(File f) throws XMLToolsException {
 		return parseXML(f)!=null;
@@ -139,7 +139,7 @@ public static final boolean isWellformedXML(File f) throws XMLToolsException {
 	 * Asserts that the specified file is well formed and returns some root node information.
 	 * @param f the file
 	 * @return returns the root node, or null if file is not well formed
-	 * @throws XMLToolsException
+	 * @throws XMLToolsException if a parser cannot be configured or if parsing fails
 	 */
 	public static final XMLInfo parseXML(File f) throws XMLToolsException {
 		return parseXML(f, false);