javadoc

[jalview.git] / src / jalview / io / JPredFile.java

diff --git a/src/jalview/io/JPredFile.java b/src/jalview/io/JPredFile.java
index dabd47a..a7e4e70 100755 (executable)
--- a/src/jalview/io/JPredFile.java
+++ b/src/jalview/io/JPredFile.java
@@ -30,9 +30,15 @@ import java.util.*;
 import jalview.datamodel.*;
 
 /**
- * DOCUMENT ME!
+ * Parser for the JPred/JNet concise format. This is a series of CSV lines,
+ * each line is either a sequence (QUERY), a sequence profile (align;), or
+ * jnet prediction annotation (anything else). 
+ * Automagic translation happens for annotation called 'JNETPRED' (translated to Secondary Structure Prediction), or 'JNETCONF' (translates to 'Prediction Confidence').
+ * Numeric scores are differentiated from symbolic by being parseable into a float vector. They are put in Scores.
+ * Symscores gets the others.
+ * JNetAnnotationMaker translates the data parsed by this object into annotation on an alignment.
  *
- * @author $author$
+ * @author jprocter
  * @version $Revision$
  */
 public class JPredFile