You are viewing a plain text version of this content. The canonical link for it is here.
Posted to j-dev@xerces.apache.org by "SingingBush (via GitHub)" <gi...@apache.org> on 2025/07/20 18:16:30 UTC
[PR] XERCESJ-1781: fixes some Javadoc errors [xerces-j]
SingingBush opened a new pull request, #28:
URL: https://github.com/apache/xerces-j/pull/28
There are a lot of Javadoc errors at the minute. This PR fixes quite a few but further changes will still be needed
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2232837249
##########
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:
fixed in next commit
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2232837555
##########
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:
fixed in next commit
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2218838998
##########
src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java:
##########
@@ -1561,8 +1561,7 @@ protected interface Dispatcher {
* @throws IOException Thrown on i/o error.
* @throws XNIException Thrown on parse error.
*/
- public boolean dispatch(boolean complete)
- throws IOException, XNIException;
+ boolean dispatch(boolean complete) throws IOException, XNIException;
Review Comment:
this is not a javadoc error, please remove from the PR and keep it focused only on what the description and title says
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -71,12 +72,21 @@ public QName() {
clear();
} // <init>()
- /** Constructs a QName with the specified values. */
+ /**
+ * Constructs a QName with the specified values.
+ * @param prefix The qname prefix. (e.g. "a")
+ * @param localpart The qname localpart. (e.g. "foo")
Review Comment:
descriptions should be less repetitive of the argument name
##########
src/org/apache/xerces/xni/Augmentations.java:
##########
@@ -48,7 +48,7 @@ public interface Augmentations {
* @return the previous value of the specified key in the Augmentations structure,
* or <code>null</code> if it did not have one.
*/
- public Object putItem (String key, Object item);
+ Object putItem (String key, Object item);
Review Comment:
this is not a javadoc error, please remove from the PR and keep it focused only on what the description and title says
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -71,12 +72,21 @@ public QName() {
clear();
} // <init>()
- /** Constructs a QName with the specified values. */
+ /**
+ * Constructs a QName with the specified values.
+ * @param prefix The qname prefix. (e.g. "a")
Review Comment:
initial character should be lower case; i.e. The --> the
##########
src/org/apache/xerces/xni/XMLAttributes.java:
##########
@@ -83,21 +83,22 @@ public interface XMLAttributes {
*
* @param attrIndex The attribute index.
*/
- public void removeAttributeAt(int attrIndex);
+ void removeAttributeAt(int attrIndex);
/**
- * Returns the number of attributes in the list.
+ * @return the number of attributes in the list.
Review Comment:
definitely wrong
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -125,7 +135,7 @@ public void clear() {
// Cloneable methods
//
- /** Returns a clone of this object. */
+ /** @return a clone of this object. */
Review Comment:
not sure about this, might require a newer version of JDK than we require
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2230532723
##########
src/org/apache/xerces/xni/XMLAttributes.java:
##########
@@ -83,21 +83,22 @@ public interface XMLAttributes {
*
* @param attrIndex The attribute index.
*/
- public void removeAttributeAt(int attrIndex);
+ void removeAttributeAt(int attrIndex);
/**
- * Returns the number of attributes in the list.
+ * @return the number of attributes in the list.
Review Comment:
how so? the method returns an int that is the number of attributes in the list. The problem with this javadoc was that there was no `@return` and now there is. conveniently I used the description that was already there and now this javadoc block has no errors
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on PR #28:
URL: https://github.com/apache/xerces-j/pull/28#issuecomment-3419594244
pushed another commit for the UTF-8 and error thing
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2232839595
##########
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:
fixed now
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2231410540
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -100,10 +110,10 @@ public void setValues(QName qname) {
/**
* Convenience method to set the values of the qname components.
*
- * @param prefix The qname prefix. (e.g. "a")
- * @param localpart The qname localpart. (e.g. "foo")
- * @param rawname The qname rawname. (e.g. "a:foo")
- * @param uri The URI binding. (e.g. "http://foo.com/mybinding")
+ * @param prefix the qname prefix. (e.g. "a")
+ * @param localpart the qname localpart. (e.g. "foo")
Review Comment:
fixed in next commit (also: raw part)
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2233456530
##########
src/org/apache/html/dom/HTMLDOMImplementationImpl.java:
##########
@@ -82,7 +82,7 @@ public final HTMLDocument createHTMLDocument( String title )
* used to perform operations that are not specific to a particular
* document instance, e.g. to create a new document.
*
- * @return Reference to a valid DOM implementation
+ * @return a singleton reference to a valid DOM implementation
Review Comment:
how do you know this is a singleton?
##########
src/org/apache/wml/WMLAElement.java:
##########
@@ -17,10 +17,9 @@
package org.apache.wml;
/**
- * <p>The interface is modeled after DOM1 Spec for HTML from W3C.
+ * The interface is modeled after DOM1 Spec for HTML from W3C.
* The DTD used in this DOM model is from
- * <a href="http://www.wapforum.org/DTD/wml_1.1.xml">
- * http://www.wapforum.org/DTD/wml_1.1.xml</a></p>
+ * <a href="http://www.wapforum.org/DTD/wml_1.1.xml">http://www.wapforum.org/DTD/wml_1.1.xml</a>
Review Comment:
https
##########
build.xml:
##########
@@ -445,11 +445,11 @@ Authors:
<target name="javadoc-replace" unless="additional.param">
<replace token="@xerces.internal" dir="${build.src}">
- <replacevalue><![CDATA[<DL><DT><H1 style="font-size:110%">INTERNAL:</H1><DD>Usage of this class is not supported. It may be altered or removed at any time.</DD></DT></DL>]]></replacevalue>
+ <replacevalue><![CDATA[<dl><dt>INTERNAL:</dt><dd>Usage of this class is not supported. It may be altered or removed at any time.</dd></dl>]]></replacevalue>
Review Comment:
I'd still use strong here
##########
src/org/apache/wml/WMLAccessElement.java:
##########
@@ -17,10 +17,9 @@
package org.apache.wml;
/**
- * <p>The interface is modeled after DOM1 Spec for HTML from W3C.
+ * The interface is modeled after DOM1 Spec for HTML from W3C.
* The DTD used in this DOM model is from
- * <a href="http://www.wapforum.org/DTD/wml_1.1.xml">
- * http://www.wapforum.org/DTD/wml_1.1.xml</a></p>
+ * <a href="http://www.wapforum.org/DTD/wml_1.1.xml">http://www.wapforum.org/DTD/wml_1.1.xml</a>
Review Comment:
https
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on PR #28:
URL: https://github.com/apache/xerces-j/pull/28#issuecomment-3419587231
I've rebased and pushed. One thing to note, in this PR I closed `p` tags. For Javadoc this isn't actually needed and whether or not `</p>` is used varies depending on code style in the project. It certainly doesn't do any harm. Personally I prefer to close them as I've been used to strict xhtml in the past but some people prefer only to use the opening `<p>` in Javadocs. I don't mind removing them if you'd prefer.
Also, this PR doesn't fix all Javadoc errors. There's a huge amount of errors and warnings. Especially around invalid tags. Errors like `error: attribute not supported in HTML5` and a lot of warning for missing `@return` (`warning: no @return`).
I'm happy to keep going with fixing more of these in another PR but it would be good to get #23 merged first and ensure docs are built during CI. I'd recommend also, once the errors are fixed, failing builds if the Javadoc is invalid.
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2230525473
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -71,12 +72,21 @@ public QName() {
clear();
} // <init>()
- /** Constructs a QName with the specified values. */
+ /**
+ * Constructs a QName with the specified values.
+ * @param prefix The qname prefix. (e.g. "a")
+ * @param localpart The qname localpart. (e.g. "foo")
Review Comment:
for this one I think the description from the same params that already existed on another method. I don't mind changing it in both places though. Could you suggest an alternative.
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2237748424
##########
src/org/apache/html/dom/ObjectFactory.java:
##########
@@ -379,7 +379,7 @@ static Class findProviderClass(String className, ClassLoader cl,
// in both JDK 1.1 and Java 2. However, this should still
// work b/c the following should be true:
//
- // (cl == null) iff current ClassLoader == null
+ // (cl == null) if current ClassLoader == null
Review Comment:
I'll undo those.
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2231516039
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -125,7 +135,7 @@ public void clear() {
// Cloneable methods
//
- /** Returns a clone of this object. */
+ /** @return a clone of this object. */
Review Comment:
in next commit both will be in place
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2232837484
##########
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:
fixed in next commit
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on PR #28:
URL: https://github.com/apache/xerces-j/pull/28#issuecomment-3418728561
Can you merge with main?
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on PR #28:
URL: https://github.com/apache/xerces-j/pull/28#issuecomment-3130217697
I've fixed the "iff" issue and think everything should be ok based on previous feedback. I've also rejigged the commits so that this PR is now x5 commits that could potentially be reviewed in order to make it easier.
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2231500356
##########
src/org/apache/xerces/xni/XMLDocumentHandler.java:
##########
@@ -78,8 +77,7 @@ public void startDocument(XMLLocator locator, String encoding,
* @param standalone The standalone value, or null if not specified.
* @param augs Additional information that may include infoset augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @exception XNIException Thrown by handler to signal an error.
Review Comment:
fixed in next commit
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2231384304
##########
src/org/apache/html/dom/HTMLAnchorElementImpl.java:
##########
@@ -198,7 +198,7 @@ public void focus()
/**
* Constructor requires owner document.
*
- * @param owner The owner HTML document
+ * @param owner the owner HTML document
Review Comment:
done, will push again shortly
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2231500930
##########
src/org/apache/xerces/xni/XMLAttributes.java:
##########
@@ -139,7 +140,7 @@ public interface XMLAttributes {
public void getName(int attrIndex, QName attrName);
/**
- * Returns the prefix of the attribute at the specified index.
+ * @return the prefix of the attribute at the specified index.
Review Comment:
fixed in next commit
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2232839581
##########
src/org/apache/xerces/impl/xs/opti/DefaultXMLDocumentHandler.java:
##########
@@ -203,7 +203,7 @@ public void emptyElement(QName element, XMLAttributes attributes, Augmentations
* parsed from a java.io.Reader).
* @param augs Additional information that may include infoset augmentations
*
- * @exception XNIException Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
Review Comment:
do need a period at the end here since this is a second complete sentence
##########
src/org/apache/xerces/impl/xs/opti/AttrImpl.java:
##########
@@ -49,9 +49,9 @@ public AttrImpl() {
* Constructs an attribute.
*
* @param element Element which owns this attribute
- * @param prefix The QName prefix.
- * @param localpart The QName localpart.
- * @param rawname The QName rawname.
+ * @param prefix The QName prefix
Review Comment:
The --> the
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on PR #28:
URL: https://github.com/apache/xerces-j/pull/28#issuecomment-3419598101
> Any chance this can be split into smaller PRs?
I can. how do you want the split, by package? There's so many problems in the docs that it's going to be fairly large regardless. Worth pointing out that the reason for the PR was to address the actual errors put out in the build when running `ant -noinput -buildfile build.xml all` not so much the wording of the documentation. The biggest problems are, invalid html, missing `@param`, `@return`, `@throws`, and missing descriptions in some places where those are used without any text.
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2231401974
##########
src/org/apache/xerces/xni/Augmentations.java:
##########
@@ -73,8 +73,7 @@ public interface Augmentations {
/**
- * Returns an enumeration of the keys in the Augmentations structure
- *
+ * @return an {@link Enumeration} of the keys in the Augmentations structure
Review Comment:
that's fair. I'll make the changes now and push shortly
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2230807984
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -71,12 +72,21 @@ public QName() {
clear();
} // <init>()
- /** Constructs a QName with the specified values. */
+ /**
+ * Constructs a QName with the specified values.
+ * @param prefix the qname prefix. (e.g. "a")
+ * @param localpart the qname localpart. (e.g. "foo")
+ * @param rawname the qname rawname. (e.g. "a:foo")
+ * @param uri the URI binding. (e.g. "http://foo.com/mybinding")
+ */
public QName(String prefix, String localpart, String rawname, String uri) {
setValues(prefix, localpart, rawname, uri);
} // <init>(String,String,String,String)
- /** Constructs a copy of the specified QName. */
+ /**
+ * Constructs a copy of the specified QName.
+ * @param qname
Review Comment:
please include a description if you're adding a param tag. The argument name alone isn't needed.
##########
src/org/apache/html/dom/HTMLAnchorElementImpl.java:
##########
@@ -198,7 +198,7 @@ public void focus()
/**
* Constructor requires owner document.
*
- * @param owner The owner HTML document
+ * @param owner the owner HTML document
Review Comment:
this really just repeats the name of the argument in a few more words. Could you do a global search and replace that changes this to "the HTML document in which this element appears" or something like that?
##########
src/org/apache/xerces/xni/XMLDocumentHandler.java:
##########
@@ -78,8 +77,7 @@ public void startDocument(XMLLocator locator, String encoding,
* @param standalone The standalone value, or null if not specified.
* @param augs Additional information that may include infoset augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @exception XNIException Thrown by handler to signal an error.
Review Comment:
@throws
##########
src/org/apache/xerces/xni/XMLAttributes.java:
##########
@@ -83,21 +83,22 @@ public interface XMLAttributes {
*
* @param attrIndex The attribute index.
*/
- public void removeAttributeAt(int attrIndex);
+ void removeAttributeAt(int attrIndex);
/**
- * Returns the number of attributes in the list.
+ * @return the number of attributes in the list.
Review Comment:
syntax problem. You've used an @return to replace a multiparagraph doc comment.
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -88,7 +98,7 @@ public QName(QName qname) {
/**
* Convenience method to set the values of the qname components.
*
- * @param qname The qualified name to be copied.
+ * @param qname the qualified name to be copied.
Review Comment:
no period
##########
src/org/apache/xerces/xni/XMLAttributes.java:
##########
@@ -139,7 +140,7 @@ public interface XMLAttributes {
public void getName(int attrIndex, QName attrName);
/**
- * Returns the prefix of the attribute at the specified index.
+ * @return the prefix of the attribute at the specified index.
Review Comment:
no period in an @return that does not have a second phrase/sentence.
##########
src/org/apache/xerces/xni/Augmentations.java:
##########
@@ -73,8 +73,7 @@ public interface Augmentations {
/**
- * Returns an enumeration of the keys in the Augmentations structure
- *
+ * @return an {@link Enumeration} of the keys in the Augmentations structure
Review Comment:
I wonder if in these cases we should have a description and an @return. Yes, they're redundant but the process uses them for different things in the docs it generates.
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -100,10 +110,10 @@ public void setValues(QName qname) {
/**
* Convenience method to set the values of the qname components.
*
- * @param prefix The qname prefix. (e.g. "a")
- * @param localpart The qname localpart. (e.g. "foo")
- * @param rawname The qname rawname. (e.g. "a:foo")
- * @param uri The URI binding. (e.g. "http://foo.com/mybinding")
+ * @param prefix the qname prefix. (e.g. "a")
+ * @param localpart the qname localpart. (e.g. "foo")
Review Comment:
local part
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -125,7 +135,7 @@ public void clear() {
// Cloneable methods
//
- /** Returns a clone of this object. */
+ /** @return a clone of this object. */
Review Comment:
I may have been confusing this with the newer syntax for doing both the return tag and the method description with one line. However, since we don't have that you need both
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2232836960
##########
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:
fixed in next commit
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2233036799
##########
src/org/apache/xerces/impl/xs/opti/DefaultXMLDocumentHandler.java:
##########
@@ -203,7 +203,7 @@ public void emptyElement(QName element, XMLAttributes attributes, Augmentations
* parsed from a java.io.Reader).
* @param augs Additional information that may include infoset augmentations
*
- * @exception XNIException Thrown by handler to signal an error.
+ * @throws XNIException if an error occurs. This should be handled by implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}
Review Comment:
done now for all matching text. in next commit
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on PR #28:
URL: https://github.com/apache/xerces-j/pull/28#issuecomment-3128393141
> I probably won't get this finished before I leave on summer travel. Generally it helps if PRs are broken up into smaller, more focused pieces.
I wasn't planning more changes is this PR unless they are requested. The initial plan was just to address warnings/errors reported by the javadocs build target.
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2443264643
##########
src/org/apache/xml/serialize/TextSerializer.java:
##########
@@ -39,18 +39,21 @@
* serializing. For usage instructions see {@link Serializer}.
* <p>
* If an output stream is used, the encoding is taken from the
- * output format (defaults to <tt>UTF-8</tt>). If a writer is
+ * output format (defaults to <code>UTF-8</code>). If a writer is
Review Comment:
I'm doing a replace all on these now
##########
src/org/apache/xml/serialize/TextSerializer.java:
##########
@@ -229,6 +232,10 @@ protected void characters( String text, boolean unescaped )
* pre-root comments and PIs that were accumulated in the document
* (see {@link #serializePreRoot}). Pre-root will be serialized even if
* this is not the first root element of the document.
+ * </p>
+ *
+ * @param rootTagName unused
+ * @throws IOException if an I/O exception occured while serializing
Review Comment:
I'm doing a replace all on these now
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2231399221
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -88,7 +98,7 @@ public QName(QName qname) {
/**
* Convenience method to set the values of the qname components.
*
- * @param qname The qualified name to be copied.
+ * @param qname the qualified name to be copied.
Review Comment:
I've gone through and removed periods from `@param` descriptions across codebase to make it consistent. will push shortly
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2233295137
##########
build.xml:
##########
@@ -445,11 +445,11 @@ Authors:
<target name="javadoc-replace" unless="additional.param">
<replace token="@xerces.internal" dir="${build.src}">
- <replacevalue><![CDATA[<DL><DT><H1 style="font-size:110%">INTERNAL:</H1><DD>Usage of this class is not supported. It may be altered or removed at any time.</DD></DT></DL>]]></replacevalue>
+ <replacevalue><![CDATA[<dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of this class is not supported. It may be altered or removed at any time.</dd></dt></dl>]]></replacevalue>
Review Comment:
agreed, pushing now
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2233829584
##########
src/org/apache/html/dom/HTMLDOMImplementationImpl.java:
##########
@@ -82,7 +82,7 @@ public final HTMLDocument createHTMLDocument( String title )
* used to perform operations that are not specific to a particular
* document instance, e.g. to create a new document.
*
- * @return Reference to a valid DOM implementation
+ * @return a singleton reference to a valid DOM implementation
Review Comment:
because *_instance* is static final *HTMLDOMImplementationImpl* there'll only be one. I can adjust the wording but this is the singleton pattern of a constant holding an instance which is returned via a static method. The constructor is private so this is the only class where `new HTMLDOMImplementationImpl()` can be called.
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2230468931
##########
src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java:
##########
@@ -1561,8 +1561,7 @@ protected interface Dispatcher {
* @throws IOException Thrown on i/o error.
* @throws XNIException Thrown on parse error.
*/
- public boolean dispatch(boolean complete)
- throws IOException, XNIException;
+ boolean dispatch(boolean complete) throws IOException, XNIException;
Review Comment:
doing now, will rebase and push shortly. I'll make another pr to remove unnecessary modifiers from interfaces
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on PR #28:
URL: https://github.com/apache/xerces-j/pull/28#issuecomment-3419526505
I'll update it today
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] Javadoc changes in org.apache.wml [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo merged PR #28:
URL: https://github.com/apache/xerces-j/pull/28
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2237480531
##########
src/org/apache/html/dom/ObjectFactory.java:
##########
@@ -379,7 +379,7 @@ static Class findProviderClass(String className, ClassLoader cl,
// in both JDK 1.1 and Java 2. However, this should still
// work b/c the following should be true:
//
- // (cl == null) iff current ClassLoader == null
+ // (cl == null) if current ClassLoader == null
Review Comment:
this is not right; iff means if and only if. It is not a typo for if
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2238079730
##########
src/org/apache/html/dom/ObjectFactory.java:
##########
@@ -379,7 +379,7 @@ static Class findProviderClass(String className, ClassLoader cl,
// in both JDK 1.1 and Java 2. However, this should still
// work b/c the following should be true:
//
- // (cl == null) iff current ClassLoader == null
+ // (cl == null) if current ClassLoader == null
Review Comment:
all of the "iff" should be back to the way they were now
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2231512955
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -71,12 +72,21 @@ public QName() {
clear();
} // <init>()
- /** Constructs a QName with the specified values. */
+ /**
+ * Constructs a QName with the specified values.
+ * @param prefix the qname prefix. (e.g. "a")
+ * @param localpart the qname localpart. (e.g. "foo")
+ * @param rawname the qname rawname. (e.g. "a:foo")
+ * @param uri the URI binding. (e.g. "http://foo.com/mybinding")
+ */
public QName(String prefix, String localpart, String rawname, String uri) {
setValues(prefix, localpart, rawname, uri);
} // <init>(String,String,String,String)
- /** Constructs a copy of the specified QName. */
+ /**
+ * Constructs a copy of the specified QName.
+ * @param qname
Review Comment:
fixed in next commit
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2232837056
##########
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:
fixed in next commit (using same text as previous comment)
##########
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:
fixed in next commit
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2233831063
##########
src/org/apache/wml/WMLAElement.java:
##########
@@ -17,10 +17,9 @@
package org.apache.wml;
/**
- * <p>The interface is modeled after DOM1 Spec for HTML from W3C.
+ * The interface is modeled after DOM1 Spec for HTML from W3C.
* The DTD used in this DOM model is from
- * <a href="http://www.wapforum.org/DTD/wml_1.1.xml">
- * http://www.wapforum.org/DTD/wml_1.1.xml</a></p>
+ * <a href="http://www.wapforum.org/DTD/wml_1.1.xml">http://www.wapforum.org/DTD/wml_1.1.xml</a>
Review Comment:
I've replaced all `http://www.wapforum.org/DTD/wml_1.1.xml` with `https://www.wapforum.org/DTD/wml_1.1.xml` is the next commit. Worth noting that the resulting document won't render in a modern browser so it's likely that people will need to use curl to view the content. I was surprised it loaded at all as wap and wml died a long time ago.
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on PR #28:
URL: https://github.com/apache/xerces-j/pull/28#issuecomment-3421751586
Ideally either fix everything in one file, one file at a time; or fix the same issue and only that issue across all files. E.g. fix spelling errors but not anything else like missing comments or adding code tags
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2232838642
##########
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:
I suspect this was a bad auto complete while typing as I meant Writer. I'll change it to something more meaningful
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2233048017
##########
src/org/apache/xerces/impl/xs/opti/AttrImpl.java:
##########
@@ -49,9 +49,9 @@ public AttrImpl() {
* Constructs an attribute.
*
* @param element Element which owns this attribute
- * @param prefix The QName prefix.
- * @param localpart The QName localpart.
- * @param rawname The QName rawname.
+ * @param prefix The QName prefix
Review Comment:
fixed in next commit
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2233190539
##########
build.xml:
##########
@@ -445,11 +445,11 @@ Authors:
<target name="javadoc-replace" unless="additional.param">
<replace token="@xerces.internal" dir="${build.src}">
- <replacevalue><![CDATA[<DL><DT><H1 style="font-size:110%">INTERNAL:</H1><DD>Usage of this class is not supported. It may be altered or removed at any time.</DD></DT></DL>]]></replacevalue>
+ <replacevalue><![CDATA[<dl><dt><h1 style="font-size:110%">INTERNAL:</h1><dd>Usage of this class is not supported. It may be altered or removed at any time.</dd></dt></dl>]]></replacevalue>
Review Comment:
This should probably just be a string instead of an h1
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2233826988
##########
build.xml:
##########
@@ -445,11 +445,11 @@ Authors:
<target name="javadoc-replace" unless="additional.param">
<replace token="@xerces.internal" dir="${build.src}">
- <replacevalue><![CDATA[<DL><DT><H1 style="font-size:110%">INTERNAL:</H1><DD>Usage of this class is not supported. It may be altered or removed at any time.</DD></DT></DL>]]></replacevalue>
+ <replacevalue><![CDATA[<dl><dt>INTERNAL:</dt><dd>Usage of this class is not supported. It may be altered or removed at any time.</dd></dl>]]></replacevalue>
Review Comment:
fixed in next commit
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2230536492
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -125,7 +135,7 @@ public void clear() {
// Cloneable methods
//
- /** Returns a clone of this object. */
+ /** @return a clone of this object. */
Review Comment:
`@return` has been around for a long time
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on PR #28:
URL: https://github.com/apache/xerces-j/pull/28#issuecomment-3119087969
made changes to resolve comments made during review. It's now rebased & squashed. please take another look
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2230518966
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -71,12 +72,21 @@ public QName() {
clear();
} // <init>()
- /** Constructs a QName with the specified values. */
+ /**
+ * Constructs a QName with the specified values.
+ * @param prefix The qname prefix. (e.g. "a")
Review Comment:
this will increase the amount of changes as current parameter descriptions have been using capitals. however I've now gone through and changed all of them to lowercase
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2233831495
##########
src/org/apache/wml/WMLAccessElement.java:
##########
@@ -17,10 +17,9 @@
package org.apache.wml;
/**
- * <p>The interface is modeled after DOM1 Spec for HTML from W3C.
+ * The interface is modeled after DOM1 Spec for HTML from W3C.
* The DTD used in this DOM model is from
- * <a href="http://www.wapforum.org/DTD/wml_1.1.xml">
- * http://www.wapforum.org/DTD/wml_1.1.xml</a></p>
+ * <a href="http://www.wapforum.org/DTD/wml_1.1.xml">http://www.wapforum.org/DTD/wml_1.1.xml</a>
Review Comment:
same as previous - fixed all
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] fixes some Javadoc errors [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2443259681
##########
src/org/apache/xml/serialize/XMLSerializer.java:
##########
@@ -59,27 +59,31 @@
* serializing. For usage instructions see {@link Serializer}.
* <p>
* If an output stream is used, the encoding is taken from the
- * output format (defaults to <tt>UTF-8</tt>). If a writer is
+ * output format (defaults to <code>UTF-8</code>). If a writer is
Review Comment:
This needs neither tt nor code
##########
src/org/apache/xml/serialize/TextSerializer.java:
##########
@@ -39,18 +39,21 @@
* serializing. For usage instructions see {@link Serializer}.
* <p>
* If an output stream is used, the encoding is taken from the
- * output format (defaults to <tt>UTF-8</tt>). If a writer is
+ * output format (defaults to <code>UTF-8</code>). If a writer is
Review Comment:
just UTF-8
##########
src/org/apache/xml/serialize/TextSerializer.java:
##########
@@ -229,6 +232,10 @@ protected void characters( String text, boolean unescaped )
* pre-root comments and PIs that were accumulated in the document
* (see {@link #serializePreRoot}). Pre-root will be serialized even if
* this is not the first root element of the document.
+ * </p>
+ *
+ * @param rootTagName unused
+ * @throws IOException if an I/O exception occured while serializing
Review Comment:
exception --> error
##########
src/org/apache/xml/serialize/XML11Serializer.java:
##########
@@ -48,27 +48,31 @@
* serializing. For usage instructions see {@link Serializer}.
* <p>
* If an output stream is used, the encoding is taken from the
- * output format (defaults to <tt>UTF-8</tt>). If a writer is
+ * output format (defaults to <code>UTF-8</code>). If a writer is
Review Comment:
just UTF-8, no tags needed
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org
Re: [PR] [XERCESJ-1781] Javadoc changes in org.apache.wml [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on PR #28:
URL: https://github.com/apache/xerces-j/pull/28#issuecomment-3433423516
@elharo since the other related PRs have been merged I've rebased this original one which now only has changes in the `org.apache.wml` package. These are mostly just changes to use an anchor tag for the url to the *wml_1.1.xml* dtd. For some of them I went to the trouble of putting some info from the dtd in the Javadoc at the top of the file but gave up on it as I don't imagine anyone using this code (hence XERCESJ-1785).
--
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: j-dev-unsubscribe@xerces.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: j-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: j-dev-help@xerces.apache.org