--- projects/cms/source/util/uk/org/iscream/cms/util/XMLPacketMaker.java	2000/11/23 09:36:07	1.2
+++ projects/cms/source/util/uk/org/iscream/cms/util/XMLPacketMaker.java	2000/11/29 19:11:53	1.3
@@ -1,25 +1,44 @@
+//---PACKAGE DECLARATION---
+package uk.ac.ukc.iscream.xml;
+
+//---IMPORTS---
 import java.io.*;
 import java.util.ArrayList;
 
 import org.xml.sax.*;
-
 import javax.xml.parsers.SAXParserFactory;
 import javax.xml.parsers.ParserConfigurationException;
 import javax.xml.parsers.SAXParser;
 
 import uk.ac.ukc.iscream.core.*;
 
-// Paul Mutton, pjm2@ukc.ac.uk
-
-// XMLPacketMaker - Creates an XMLPacket object.
+/**
+ * XMLPacketMaker - Creates an XMLPacket object.
+ *
+ * @author  $Author: tdb $
+ * @version $Id: XMLPacketMaker.java,v 1.3 2000/11/29 19:11:53 tdb Exp $
+ */
 public class XMLPacketMaker extends HandlerBase {
 
+//---FINAL ATTRIBUTES---
+
+    /**
+     * The current CVS revision of this class
+     */
+    public final String REVISION = "$Revision: 1.3 $";
+    
+//---STATIC METHODS---
+
+//---CONSTRUCTORS---
+
     // Constructor for accepting XML input.
     public XMLPacketMaker (String xml, Logger logger) {
         this.xml = xml;
         this.logger = logger;
     }
 
+//---PUBLIC METHODS---
+
     public XMLPacket createXMLPacket() {
 
         // Create the XMLPacket to store values in.
@@ -43,7 +62,26 @@ public class XMLPacketMaker extends HandlerBase {
         
         return packet;
     }
-    
+
+    /**
+     * Overrides the {@link java.lang.Object#toString() Object.toString()}
+     * method to provide clean logging (every class should have this).
+     *
+     * @return the name of this class and its CVS revision
+     */
+    public String toString() {
+        return this.getClass().getName() + "(" + REVISION.substring(11, REVISION.length() - 2) + ")";
+    }
+
+//---PRIVATE METHODS---
+
+//---ACCESSOR/MUTATOR METHODS---
+
+//---ATTRIBUTES---
+
     String xml;
     Logger logger;
-}
\ No newline at end of file
+
+//---STATIC ATTRIBUTES---
+
+}