specify fail behavior (returns null) in javadoc

Added @return to javadoc including a statement about behavior when failing. Signed-off-by: Egon Willighagen <egonw@users.sourceforge.net>
cdk · Jun 19, 2010 · bfd06db · bfd06db
1 parent c94ebcf
commit bfd06db
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/main/org/openscience/cdk/io/FormatFactory.java b/src/main/org/openscience/cdk/io/FormatFactory.java
@@ -139,6 +139,8 @@ public List<IChemFormatMatcher> getFormats(){
      *
      * @throws IOException  if an I/O error occurs
      * @throws IllegalArgumentException if the input is null
+     * @return The guessed <code>IChemFormat</code> or <code>null</code> if the 
+     *         file format is not recognized.
      *
      * @see #guessFormat(InputStream)
      */