[MO-java-dev] CVS: mockobjects-java/doc SiteHack.java,1.1,1.2

[Jeff M. <cus...@us...>]

Update of /cvsroot/mockobjects/mockobjects-java/doc
In directory usw-pr-cvs1:/tmp/cvs-serv6048

Modified Files:
	SiteHack.java 
Log Message:
Added usage comments


Index: SiteHack.java
===================================================================
RCS file: /cvsroot/mockobjects/mockobjects-java/doc/SiteHack.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SiteHack.java	29 Aug 2002 12:17:21 -0000	1.1
+++ SiteHack.java	3 Sep 2002 10:02:50 -0000	1.2
@@ -2,6 +2,18 @@
 import java.text.MessageFormat;
 
 /**
+ * SiteHack is a simple templating tool used to build the MockObjects site.
+ * It takes as it's arguements a list of text files, the first of these is
+ * the name of the file to be used as the template. All files specified 
+ * after this will be inserted into this template file before the result of the
+ * merge is written into a directory called out.
+ * If the out directory does not exist it will automatically be create prior to
+ * writing the merged files.
+ * The template file can be any plain text file. The pattern {0} is used to mark
+ * the point where other files will be inserted. If the characters { or } are
+ * used within the template other than the merge point these need to be escaped
+ * by sourrounding them in single quotes e.g. '{'
+ *
  * $Revision$
  */
 public class SiteHack {