Merge pull request psiegman#126 from nelkinda/master

Fix a few Javadoc issues.
nelkinda · Dec 16, 2019 · 5df3765 · 5df3765
2 parents c5aafb2 + 69ac6b0
commit 5df3765
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/epublib-core/src/main/java/nl/siegmann/epublib/domain/LazyResource.java b/epublib-core/src/main/java/nl/siegmann/epublib/domain/LazyResource.java
@@ -35,7 +35,7 @@ public class LazyResource extends Resource {
 	 * 
 	 * The data will be loaded on the first call to getData()
 	 * 
-	 * @param fileName the fileName for the epub we're created from.
+	 * @param filename the file name for the epub we're created from.
 	 * @param size the size of this resource.
 	 * @param href The resource's href within the epub.
 	 */

diff --git a/epublib-core/src/main/java/nl/siegmann/epublib/epub/EpubReader.java b/epublib-core/src/main/java/nl/siegmann/epublib/epub/EpubReader.java
@@ -61,7 +61,7 @@ public Book readEpub(InputStream in, String encoding) throws IOException {
 	/**
 	 * Reads this EPUB without loading any resources into memory.
 	 * 
-	 * @param fileName the file to load
+	 * @param zipFile the file to load
 	 * @param encoding the encoding for XHTML files
 	 * 
 	 * @return this Book without loading all resources into memory.
@@ -82,7 +82,7 @@ public Book readEpub(ZipFile in, String encoding) throws IOException {
     /**
 	 * Reads this EPUB without loading all resources into memory.
 	 * 
-	 * @param fileName the file to load
+	 * @param zipFile the file to load
 	 * @param encoding the encoding for XHTML files
 	 * @param lazyLoadedTypes a list of the MediaType to load lazily
 	 * @return this Book without loading all resources into memory.

diff --git a/epublib-core/src/main/java/nl/siegmann/epublib/util/commons/io/BOMInputStream.java b/epublib-core/src/main/java/nl/siegmann/epublib/util/commons/io/BOMInputStream.java
@@ -65,7 +65,7 @@
  *      }
  * </pre>
  *
- * @see org.apache.commons.io.ByteOrderMark
+ * @see ByteOrderMark
  * @see <a href="http://en.wikipedia.org/wiki/Byte_order_mark">Wikipedia - Byte Order Mark</a>
  * @version $Revision: 1052095 $ $Date: 2010-12-22 23:03:20 +0000 (Wed, 22 Dec 2010) $
  * @since Commons IO 2.0

diff --git a/epublib-core/src/main/java/nl/siegmann/epublib/util/commons/io/ByteOrderMark.java b/epublib-core/src/main/java/nl/siegmann/epublib/util/commons/io/ByteOrderMark.java
@@ -21,9 +21,9 @@
 
 /**
  * Byte Order Mark (BOM) representation -
- * see {@link org.apache.commons.io.input.BOMInputStream}.
+ * see {@link BOMInputStream}.
  *
- * @see org.apache.commons.io.input.BOMInputStream
+ * @see BOMInputStream
  * @see <a href="http://en.wikipedia.org/wiki/Byte_order_mark">Wikipedia - Byte Order Mark</a>
  * @version $Id: ByteOrderMark.java 1005099 2010-10-06 16:13:01Z niallp $
  * @since Commons IO 2.0