elharo commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2232201295
##########
src/org/apache/xml/serialize/XMLSerializer.java:
##########
@@ -1388,7 +1392,7 @@ protected void printText( char[] chars, int start, int
length,
* DOM Level 3:
* Check a node to determine if it contains unbound namespace prefixes.
*
- * @param node The node to check for unbound namespace prefices
+ * @param node the node to check for unbound namespace prefices
Review Comment:
prefixes
##########
src/org/apache/xml/serialize/XMLSerializer.java:
##########
@@ -1099,9 +1103,9 @@ protected void serializeElement( Element elem )
* Serializes a namespace attribute with the given prefix and value for
URI.
* In case prefix is empty will serialize default namespace declaration.
*
- * @param prefix
- * @param uri
- * @exception IOException
+ * @param prefix the namespace prefix. If empty the default namespace
declaration will be used
+ * @param uri the uri value
Review Comment:
the namespace URI
##########
src/org/apache/xml/serialize/Printer.java:
##########
@@ -185,7 +193,10 @@ public void printText( String text )
}
}
-
+ /**
+ * @param text the StringBuffer value to write to the buffer
Review Comment:
the value to write to the buffer
##########
src/org/apache/xml/serialize/XMLSerializer.java:
##########
@@ -1099,9 +1103,9 @@ protected void serializeElement( Element elem )
* Serializes a namespace attribute with the given prefix and value for
URI.
* In case prefix is empty will serialize default namespace declaration.
*
- * @param prefix
- * @param uri
- * @exception IOException
+ * @param prefix the namespace prefix. If empty the default namespace
declaration will be used
+ * @param uri the uri value
+ * @exception IOException will be thrown if cannot write the attribute
Review Comment:
if the attribute cannot be written
##########
src/org/apache/xerces/xs/XSModel.java:
##########
@@ -82,77 +82,77 @@ public XSNamedMap getComponentsByNamespace(short objectType,
/**
* Convenience method. Returns a top-level element declaration.
* @param name The name of the declaration.
- * @param namespace The namespace of the declaration, otherwise
- * <code>null</code>.
- * @return A top-level element declaration or <code>null</code> if such a
- * declaration does not exist.
+ *
+ * @param namespace the namespace of the declaration, otherwise
+ * <code>null</code>
+ * @return a top-level element declaration or <code>null</code> if such a
+ * declaration does not exist
*/
public XSElementDeclaration getElementDeclaration(String name,
String namespace);
/**
- * Convenience method. Returns a top-level attribute declaration.
- * @param name The name of the declaration.
- * @param namespace The namespace of the declaration, otherwise
- * <code>null</code>.
- * @return A top-level attribute declaration or <code>null</code> if such
- * a declaration does not exist.
+ * Convenience method. Returns a top-level attribute declaration.
+ *
+ * @param name the name of the declaration
+ * @param namespace the namespace of the declaration, otherwise
<code>null</code>
+ * @return a top-level attribute declaration or <code>null</code> if such
+ * a declaration does not exist
*/
public XSAttributeDeclaration getAttributeDeclaration(String name,
String namespace);
/**
- * Convenience method. Returns a top-level simple or complex type
- * definition.
- * @param name The name of the definition.
- * @param namespace The namespace of the declaration, otherwise
- * <code>null</code>.
- * @return An <code>XSTypeDefinition</code> or <code>null</code> if such
- * a definition does not exist.
+ * Convenience method. Returns a top-level simple or complex type
definition.
+ *
+ * @param name the name of the definition
+ * @param namespace the namespace of the declaration, otherwise
<code>null</code>
+ * @return an <code>XSTypeDefinition</code> or <code>null</code> if such
+ * a definition does not exist
*/
public XSTypeDefinition getTypeDefinition(String name,
String namespace);
/**
- * Convenience method. Returns a top-level attribute group definition.
- * @param name The name of the definition.
- * @param namespace The namespace of the definition, otherwise
- * <code>null</code>.
- * @return A top-level attribute group definition or <code>null</code> if
- * such a definition does not exist.
+ * Convenience method. Returns a top-level attribute group definition.
+ *
+ * @param name the name of the definition
+ * @param namespace the namespace of the definition, otherwise
<code>null</code>
+ * @return a top-level attribute group definition or <code>null</code> if
+ * such a definition does not exist
*/
public XSAttributeGroupDefinition getAttributeGroup(String name,
String namespace);
/**
- * Convenience method. Returns a top-level model group definition.
- * @param name The name of the definition.
- * @param namespace The namespace of the definition, otherwise
- * <code>null</code>.
- * @return A top-level model group definition or <code>null</code> if
- * such a definition does not exist.
+ * Convenience method. Returns a top-level model group definition.
+ *
+ * @param name the name of the definition
+ * @param namespace the namespace of the definition, otherwise
<code>null</code>
+ * @return a top-level model group definition or <code>null</code> if
+ * such a definition does not exist
*/
public XSModelGroupDefinition getModelGroupDefinition(String name,
String namespace);
/**
- * Convenience method. Returns a top-level notation declaration.
- * @param name The name of the declaration.
- * @param namespace The namespace of the declaration, otherwise
- * <code>null</code>.
+ * Convenience method. Returns a top-level notation declaration.
+ *
+ * @param name The name of the declaration
Review Comment:
the
##########
src/org/apache/xml/serialize/XMLSerializer.java:
##########
@@ -1131,7 +1135,7 @@ private void printNamespaceAttr(String prefix, String
uri) throws IOException{
* @param name
* @param value
* @param isSpecified
- * @exception IOException
+ * @exception IOException will be thrown if cannot write the attribute
Review Comment:
if the attribute cannot be printed
##########
src/org/apache/xml/serialize/Printer.java:
##########
@@ -162,7 +167,10 @@ public String leaveDTD()
return null;
}
-
+ /**
+ * @param text the string value to write to the buffer
Review Comment:
the value to write to the buffer
##########
src/org/apache/xml/serialize/Printer.java:
##########
@@ -148,6 +150,9 @@ public void enterDTD()
* Called by the root element to leave DTD mode and if any
* DTD parts were printer, will return a string with their
* textual content.
+ *
+ * @return The {@link StringWriter#toString()} value or <code>null</code>
Review Comment:
what stringwriter? what is it the meaning of what it's returning
--
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]
