Added javadoc to XMLParser and notice about not closing the input stream in JavaUtils (#189)

* JavaUtils: Added javadoc that the method doesn't close the input

* Added javadoc to XMLParser

Signed-off-by: David Matějček <david.matejcek@omnifish.ee>

---------

Signed-off-by: David Matějček <david.matejcek@omnifish.ee>

Author: dmatej

src/main/java/org/apache/xml/security/parser/XMLParser.java

@@ -27,6 +27,15 @@
  */
 public interface XMLParser {
 
+    /**
+     * Parses a document from the input stream.
+     * Caller is responsible for closing the stream.
+     *
+     * @param inputStream
+     * @param disallowDocTypeDeclarations
+     * @return {@link Document}
+     * @throws XMLParserException
+     */
     Document parse(InputStream inputStream, boolean disallowDocTypeDeclarations) throws XMLParserException;
 
 }

src/main/java/org/apache/xml/security/utils/JavaUtils.java

@@ -91,7 +91,7 @@ public static void writeBytesToFilename(String filename, byte[] bytes) {
 
     /**
      * This method reads all bytes from the given InputStream till EOF and
-     * returns them as a byte array.
+     * returns them as a byte array. The method doesn't close the input stream.
      *
      * @param inputStream
      * @return the bytes read from the stream