elharo commented on code in PR #39:
URL: https://github.com/apache/xerces-j/pull/39#discussion_r2473445992
##########
src/org/apache/xml/serialize/OutputFormat.java:
##########
@@ -837,6 +860,8 @@ public void setLineWidth( int lineWidth )
* Returns the last printable character based on the selected
* encoding. Control characters and non-printable characters
* are always printed as character references.
+ *
+ * @return the last printable character based on the selected encoding
Review Comment:
delete "selected"
##########
src/org/apache/xml/serialize/SerializerFactory.java:
##########
@@ -34,7 +34,19 @@
*/
@Deprecated
public abstract class SerializerFactory {
-
+
+ /**
+ * This value should be used as a system property for registering
additional implementations of SerializerFactory.
Review Comment:
"This value should be used as a system " --> "The system"
##########
src/org/apache/xml/serialize/OutputFormat.java:
##########
@@ -724,10 +743,10 @@ public boolean isNonEscapingElement( String tagName )
/**
- * Sets the list of elements for which text node children
+ * Sets the array of elements for which text node children
Review Comment:
I'd just say "Sets the elements "
##########
src/org/apache/xml/serialize/OutputFormat.java:
##########
@@ -741,7 +760,7 @@ public void setNonEscapingElements( String[]
nonEscapingElements )
* Web line separator (<code>\n</code>). A string is returned to
* support double codes (CR + LF).
*
- * @return The specified line separator
+ * @return the specified line separator
Review Comment:
delete "specified"
##########
src/org/apache/xml/serialize/OutputFormat.java:
##########
@@ -798,6 +819,8 @@ public void setPreserveSpace( boolean preserve )
* When indenting, and only when indenting, long lines will be
* broken at space boundaries based on this line width.
* No line wrapping occurs if this value is zero.
+ *
+ * @return the selected line width for breaking up long lines
Review Comment:
delete "selected"
##########
src/org/apache/xml/serialize/OutputFormat.java:
##########
@@ -955,6 +985,18 @@ public static String whichDoctypeSystem( Document doc )
/**
* Returns the suitable media format for a document
* output with the specified method.
+ *
+ * <p>Supported methods are:</p>
+ * <ul>
+ * <li>xml</li>
+ * <li>html</li>
+ * <li>xhtml</li>
+ * <li>test</li>
+ * <li>fop</li>
+ * </ul>
+ *
+ * @param method for which a media type is required
+ * @return the suitable media format for a document, or null
Review Comment:
delete "suitable"
##########
src/org/apache/xml/serialize/OutputFormat.java:
##########
@@ -724,10 +743,10 @@ public boolean isNonEscapingElement( String tagName )
/**
- * Sets the list of elements for which text node children
+ * Sets the array of elements for which text node children
* should be output unescaped (no character references).
*
- * @param nonEscapingElements List of unescaped element tag names
+ * @param nonEscapingElements array of unescaped element tag names
Review Comment:
delete "array of "
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
