Changeset 10214 for trunk/gli/src/org/greenstone/gatherer/util/Zipup.java

Timestamp:

2005-07-06T15:18:57+12:00 (19 years ago)

Author:

mdewsnip

Message:

Some comments by Matthew Whyte.

File:

• trunk/gli/src/org/greenstone/gatherer/util/Zipup.java (modified) (1 diff)

trunk/gli/src/org/greenstone/gatherer/util/Zipup.java

@@ -40 +40 @@
 import java.io.File;
 
-/*
-  Class to zip up a given directory of a given Greenstone collection.
-
-  Arguments:
-  gsdlhome, the home of greensone, eg "/research/mgw5/gsdl/"
-  collecion, thename of the collection, eg "mgw5-test"
-  dir, the name of the directory to zip up, eg "archives"
-  [accept_expression], a regular expression of files to exclusively include in the archive
-  [reject_expression], a regular expression of files to exclude from the archive
-
-  @see org.greenstone.gatherer.util.Utility#zipup
+/**
+ * Zip up a given directory of a given Greenstone collection.
+ * The actual zipping code is contained in {@link Utility.zipup(String, String, String, GShell, String, String)}.
+ * This class basically contains a main method that requires adequate arguments to call the zipup method.
+ *
+ * Arguments:
+ * <br>gsdlhome, the home of greensone, eg "/research/mgw5/gsdl/"
+ * <br>collecion, the name of the collection, eg "mgw5-test"
+ * <br>directory, the name of the directory to zip up, eg "archives"
+ * <br>[accept_expression], a regular expression of files to exclusively include in the archive. Optional.
+ * <br>[reject_expression], a regular expression of files to exclude from the archive. Optional.
+ *
+ * @see Utility.zipup(String, String, String, GShell, String, String)
  */
 public class Zipup {