[prev in list] [next in list] [prev in thread] [next in thread] 

List:       xerces-cvs
Subject:    svn commit: r1514806 - /xerces/java/trunk/src/org/apache/xerces/impl/XMLDTDScannerImpl.java
From:       mrglavas () apache ! org
Date:       2013-08-16 17:29:03
Message-ID: 20130816172903.2406D238890D () eris ! apache ! org
[Download RAW message or body]

Author: mrglavas
Date: Fri Aug 16 17:29:02 2013
New Revision: 1514806

URL: http://svn.apache.org/r1514806
Log:
Javadoc improvements for the startPE() and scanEntityValue() methods.

Modified:
    xerces/java/trunk/src/org/apache/xerces/impl/XMLDTDScannerImpl.java

Modified: xerces/java/trunk/src/org/apache/xerces/impl/XMLDTDScannerImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/impl/XMLDTDScannerImpl.java?rev=1514806&r1=1514805&r2=1514806&view=diff
 ==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/impl/XMLDTDScannerImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/impl/XMLDTDScannerImpl.java Fri Aug 16 \
17:29:02 2013 @@ -630,6 +630,8 @@ public class XMLDTDScannerImpl
      *
      * @param name The name of the parameter entity to start (without the '%')
      * @param literal Whether this is happening within a literal
+     * 
+     * @return The name of the parameter entity (with the '%')
      */
     protected String startPE(String name, boolean literal) 
         throws IOException, XNIException {
@@ -1569,15 +1571,17 @@ public class XMLDTDScannerImpl
     } // scanEntityDecl()
 
     /**
-     * Scans an entity value.
+     * <p>Scans an entity value.</p>
+     * 
+     * <p><strong>Note:</strong> This method uses fString, fStringBuffer (through
+     * the use of scanCharReferenceValue), and fStringBuffer2, anything in them
+     * at the time of calling is lost.</p>
      *
      * @param value The string to fill in with the value.
      * @param nonNormalizedValue The string to fill in with the 
      *                           non-normalized value.
-     *
-     * <strong>Note:</strong> This method uses fString, fStringBuffer (through
-     * the use of scanCharReferenceValue), and fStringBuffer2, anything in them
-     * at the time of calling is lost.
+     *                           
+     * @return Count of direct and indirect references to parameter entities in the \
                value of the entity.              
      */
     protected final int scanEntityValue(XMLString value, 
                                         XMLString nonNormalizedValue)



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xerces.apache.org
For additional commands, e-mail: commits-help@xerces.apache.org


[prev in list] [next in list] [prev in thread] [next in thread]