PDFBOX-5660: improve javadoc, as suggested by Valery Bokov; closes #319
git-svn-id: https://svn.apache.org/repos/asf/pdfbox/trunk@1929613 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/io/src/main/java/org/apache/pdfbox/io/IOUtils.java b/io/src/main/java/org/apache/pdfbox/io/IOUtils.java
index d3589f3..006051e 100644
--- a/io/src/main/java/org/apache/pdfbox/io/IOUtils.java
+++ b/io/src/main/java/org/apache/pdfbox/io/IOUtils.java
@@ -167,11 +167,13 @@
}
/**
- * Unmap memory mapped byte buffers. This is a hack waiting for a proper JVM provided solution expected in java 10
- * https://bugs.openjdk.java.net/browse/JDK-4724038 The issue here is that even when closed, memory mapped byte
- * buffers hold a lock on the underlying file until GC is executes and this in turns result in an error if the user
- * tries to move or delete the file.
- *
+ * Unmap memory mapped byte buffers. This is a hack waiting for a proper JVM provided solution
+ * mentioned in
+ * <a href="https://bugs.openjdk.java.net/browse/JDK-4724038">JDK-4724038: Add unmap method to
+ * MappedByteBuffer</a>. The issue here is that even when closed, memory mapped byte buffers
+ * hold a lock on the underlying file until GC is executing and this in turns result in an error
+ * if the user tries to move or delete the file.
+ *
* @param buf the buffer to be unmapped
*/
public static void unmap(ByteBuffer buf)
