From: jprocter <jprocter@compbio.dundee.ac.uk>
Date: Fri, 13 Jan 2006 15:52:34 +0000 (+0000)
Subject: comments
X-Git-Tag: Release_0.2~401
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=236aa085fe0fa0017ea24b6ca23c9b42b69c4f36;p=vamsas.git

comments

git-svn-id: https://svn.lifesci.dundee.ac.uk/svn/repository/trunk@119 be28352e-c001-0410-b1a7-c7978e42abec
---

diff --git a/src/org/vamsas/test/simpleclient/ArchiveReports.java b/src/org/vamsas/test/simpleclient/ArchiveReports.java
index d2eaf84..7ff04b3 100644
--- a/src/org/vamsas/test/simpleclient/ArchiveReports.java
+++ b/src/org/vamsas/test/simpleclient/ArchiveReports.java
@@ -8,7 +8,12 @@ import org.vamsas.objects.core.VAMSAS;
 import org.vamsas.objects.core.VamsasDocument;
 
 public class ArchiveReports {
-
+    /**
+     * print an informative summary on a VamsasDocument
+     * @param document - the document itself
+     * @param archive - document source archive for resolving any appData refs
+     * @return
+     */
   public static boolean reportDocument(VamsasDocument document, VamsasArchiveReader archive) {
     if (document!=null) {
       System.out.print("Vamsas Document version '"+document.getVersion()+"'");
@@ -46,6 +51,11 @@ public class ArchiveReports {
     return false;
   }
 
+  /**
+   * summarises all the datasets in a vamsas document.
+   * @param roots
+   * @return
+   */
   public static boolean rootReport(VAMSAS[] roots) {
     if (roots!=null) {
       for (int i=0; i<roots.length; i++) {