Merge branch 'docs/2_8_1_Release' into Release_2_8_1_Branch

[jalview.git] / src / jalview / datamodel / Annotation.java

diff --git a/src/jalview/datamodel/Annotation.java b/src/jalview/datamodel/Annotation.java
index c9a623b..93b6ff6 100755 (executable)
--- a/src/jalview/datamodel/Annotation.java
+++ b/src/jalview/datamodel/Annotation.java
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
+ * Copyright (C) 2014 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
@@ -14,6 +14,7 @@
  * PURPOSE.  See the GNU General Public License for more details.
  * 
  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.datamodel;
 
@@ -122,6 +123,15 @@ public class Annotation
     this(null, null, ' ', val);
   }
 
+  /**
+   * human readable representation of an annotation row element.
+   *
+   * Format is 'display Char','secondary Structure
+   * Char',"description",score,[colourstring]
+   *
+   * fields may be missing if they are null, whitespace, or equivalent to
+   * Float.NaN
+   */
   @Override
   public String toString()
   {