Author: mrglavas
Date: Fri Aug 16 17:29:22 2013
New Revision: 1514807
URL: http://svn.apache.org/r1514807
Log:
Javadoc improvements for the startPE() and scanEntityValue() methods.
Modified:
xerces/java/branches/xml-schema-1.1-dev/src/org/apache/xerces/impl/XMLDTDScannerImpl.java
Modified:
xerces/java/branches/xml-schema-1.1-dev/src/org/apache/xerces/impl/XMLDTDScannerImpl.java
URL:
http://svn.apache.org/viewvc/xerces/java/branches/xml-schema-1.1-dev/src/org/apache/xerces/impl/XMLDTDScannerImpl.java?rev=1514807&r1=1514806&r2=1514807&view=diff
==============================================================================
---
xerces/java/branches/xml-schema-1.1-dev/src/org/apache/xerces/impl/XMLDTDScannerImpl.java
(original)
+++
xerces/java/branches/xml-schema-1.1-dev/src/org/apache/xerces/impl/XMLDTDScannerImpl.java
Fri Aug 16 17:29:22 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: [email protected]
For additional commands, e-mail: [email protected]