More javadocs

[jabaws.git] / datamodel / compbio / data / sequence / SequenceUtil.java

diff --git a/datamodel/compbio/data/sequence/SequenceUtil.java b/datamodel/compbio/data/sequence/SequenceUtil.java
index 935ce74..ddd1222 100644 (file)
--- a/datamodel/compbio/data/sequence/SequenceUtil.java
+++ b/datamodel/compbio/data/sequence/SequenceUtil.java
@@ -303,13 +303,23 @@ public final class SequenceUtil {
        }\r
 \r
        /**\r
-        * Reader for JRonn horizontal file format >Foobar M G D T T A G 0.48 0.42\r
-        * 0.42 0.48 0.52 0.53 0.54 All values are tab delimited\r
+        * Reader for JRonn horizontal file format\r
+        * \r
+        * <pre>\r
+        * &gtFoobar M G D T T A G 0.48 0.42\r
+        * 0.42 0.48 0.52 0.53 0.54\r
+        * \r
+        * <pre>\r
+        * Where all values are tab delimited\r
         * \r
         * @param inStream\r
-        * @return\r
+        *            the InputStream connected to the JRonn output file\r
+        * @return List of {@link AnnotatedSequence} objects\r
         * @throws IOException\r
+        *             is thrown if the inStream has problems accessing the data\r
         * @throws UnknownFileFormatException\r
+        *             is thrown if the inStream represents an unknown source of\r
+        * data, i.e. not a JRonn output\r
         */\r
        public static List<AnnotatedSequence> readJRonn(final InputStream inStream)\r
                        throws IOException, UnknownFileFormatException {\r
@@ -403,7 +413,7 @@ public final class SequenceUtil {
         * @throws IOException\r
         * @throws UnknownFileFormatException\r
         */\r
-       public static List<MultiAnnotatedSequence<DisemblResultAnnot>> readDisembl(\r
+       static List<MultiAnnotatedSequence<DisemblResultAnnot>> readDisembl(\r
                        final InputStream input) throws IOException,\r
                        UnknownFileFormatException {\r
                Scanner scan = new Scanner(input);\r