svn commit: r898127 - in /lucene/solr/trunk: CHANGES.txt src/java/org/apache/solr/request/XMLWriter.java

[hossman]

Author: hossman
Date: Tue Jan 12 00:11:23 2010
New Revision: 898127

URL: http://svn.apache.org/viewvc?rev=898127&view=rev
Log:
SOLR-1590: Javadoc for XMLWriter#startTag

Modified:
    lucene/solr/trunk/CHANGES.txt
    lucene/solr/trunk/src/java/org/apache/solr/request/XMLWriter.java

Modified: lucene/solr/trunk/CHANGES.txt
URL: 
http://svn.apache.org/viewvc/lucene/solr/trunk/CHANGES.txt?rev=898127&r1=898126&r2=898127&view=diff
==============================================================================
--- lucene/solr/trunk/CHANGES.txt (original)
+++ lucene/solr/trunk/CHANGES.txt Tue Jan 12 00:11:23 2010
@@ -211,6 +211,9 @@
 Documentation
 ----------------------
 
+* SOLR-1590: Javadoc for XMLWriter#startTag
+  (Chris A. Mattmann via hossman)
+
 ================== Release 1.4.0 ==================
 Release Date:  See http://lucene.apache.org/solr for the official release date.
 

Modified: lucene/solr/trunk/src/java/org/apache/solr/request/XMLWriter.java
URL: 
http://svn.apache.org/viewvc/lucene/solr/trunk/src/java/org/apache/solr/request/XMLWriter.java?rev=898127&r1=898126&r2=898127&view=diff
==============================================================================
--- lucene/solr/trunk/src/java/org/apache/solr/request/XMLWriter.java (original)
+++ lucene/solr/trunk/src/java/org/apache/solr/request/XMLWriter.java Tue Jan 
12 00:11:23 2010
@@ -261,6 +261,19 @@
 
 
 
+  /**
+   * Begins the writing of an XML tag output, using the provided 
+   * <code>tag</code> as the name, with an optional <code>name</code>
+   * attribute, set to the provided value of name. If <code>closeTag</code> is
+   * set to true, then the tag is written with no internal text value.
+   * 
+   * @param tag The name of the XML tag to write.
+   * @param name If provided (not set to null), a &quot;name&quot; attribute is
+   * written to the tag, with the value set to the provided parameter.
+   * @param closeTag If set to true, then the tag is closed, without writing 
any
+   * internal text value.
+   * @throws IOException If the underlying {...@link #writer} throws an 
Exception.
+   */
   public void startTag(String tag, String name, boolean closeTag) throws 
IOException {
     if (doIndent) indent();