[MOBY-guts] biomoby commit

[Eddie Kawas]

kawas
Mon Dec 20 12:13:06 EST 2004
Update of /home/repository/moby/moby-live/Java/src/main/org/biomoby/client/gui/util
In directory pub.open-bio.org:/tmp/cvs-serv13098/org/biomoby/client/gui/util

Modified Files:
	ObjectXMLWriter.java 
Log Message:
Added/Modified documentation

moby-live/Java/src/main/org/biomoby/client/gui/util ObjectXMLWriter.java,1.1,1.2
===================================================================
RCS file: /home/repository/moby/moby-live/Java/src/main/org/biomoby/client/gui/util/ObjectXMLWriter.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- /home/repository/moby/moby-live/Java/src/main/org/biomoby/client/gui/util/ObjectXMLWriter.java	2004/12/18 18:48:26	1.1
+++ /home/repository/moby/moby-live/Java/src/main/org/biomoby/client/gui/util/ObjectXMLWriter.java	2004/12/20 17:13:06	1.2
@@ -6,8 +6,7 @@
 
 /**
  * @author Eddie Kawas
- * <p>Created for
- * <p>This class was created to ...
+ * <p>This class was created to query mobycentral in order to return the xml representation of a moby object.
  * <p>For questions, comments, or bugs
  * <p>email me at edward.kawas at gmail.com
  */
@@ -19,6 +18,13 @@
 import org.jdom.output.XMLOutputter;
 
 public class ObjectXMLWriter {
+    /**
+     *  
+     * <b>PRE:</b>unformattedXML is valid XML.<p>
+     * <b>POST:</b>Pretty, i.e. tabbed, spaced, etc, XML is returned.<p>
+     * @param unformattedXML - a string of xml that will be to look orderly.
+     * @return an XML string outputted neatly.
+     */
    public static String generatePrettyXML(String unformattedXML) {
         try {
             ByteArrayOutputStream buf = new ByteArrayOutputStream();