[commons-imaging] branch master updated: Add description to Javadoc @throws tag, fixing warning when running mvn in JDK 8

[kinow]

This is an automated email from the ASF dual-hosted git repository.

kinow pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-imaging.git


The following commit(s) were added to refs/heads/master by this push:
     new ef18213  Add description to Javadoc @throws tag, fixing warning when 
running mvn in JDK 8
ef18213 is described below

commit ef1821369da871e0cb1c4a36a1ad7ac17529e08e
Author: Bruno P. Kinoshita <ki...@users.noreply.github.com>
AuthorDate: Mon Oct 19 14:08:43 2020 +1300

    Add description to Javadoc @throws tag, fixing warning when running mvn in 
JDK 8
---
 src/main/java/org/apache/commons/imaging/common/BinaryFunctions.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git 
a/src/main/java/org/apache/commons/imaging/common/BinaryFunctions.java 
b/src/main/java/org/apache/commons/imaging/common/BinaryFunctions.java
index 80c2f1b..3c67c18 100644
--- a/src/main/java/org/apache/commons/imaging/common/BinaryFunctions.java
+++ b/src/main/java/org/apache/commons/imaging/common/BinaryFunctions.java
@@ -293,7 +293,7 @@ public final class BinaryFunctions {
      * @param quad a quad (the needle)
      * @param bis an input stream (the haystack)
      * @return {@code true} if it found the quad, and {@code false} otherwise
-     * @throws IOException
+     * @throws IOException if it fails to read from the given input stream
      */
     public static boolean searchQuad(int quad, InputStream bis) throws 
IOException {
         byte[] needle = BinaryFunctions.quadsToByteArray(quad);