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/11/24 08:41:52 UTC
[PR] [XERCESJ-1781] fix more Javadoc [xerces-j]
SingingBush opened a new pull request, #64:
URL: https://github.com/apache/xerces-j/pull/64
(no comment)
--
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] fix more Javadoc [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #64:
URL: https://github.com/apache/xerces-j/pull/64#discussion_r2557396127
##########
src/org/apache/html/dom/HTMLDocumentImpl.java:
##########
@@ -614,23 +650,35 @@ public void close()
}
}
-
+ /**
+ * Write a string.
+ * <p>Not supported</p>
+ *
+ * @param text a string to write
+ */
+ @Override
public void write( String text )
{
// Write a string into the in-memory writer.
if ( _writer != null )
_writer.write( text );
}
-
+ /**
+ * Write a line into the in-memory writer.
Review Comment:
don't mention the in-memory writer. Just say this method has no effect.
##########
src/org/apache/html/dom/HTMLDocumentImpl.java:
##########
@@ -614,23 +650,35 @@ public void close()
}
}
-
+ /**
+ * Write a string.
+ * <p>Not supported</p>
Review Comment:
Instead of Not supported I might say "This is a no-op in this class." or something like that.
##########
src/org/apache/html/dom/HTMLDocumentImpl.java:
##########
@@ -595,7 +625,10 @@ public HTMLCollection getAnchors()
return _anchors;
}
-
+ /**
+ * Not supported
Review Comment:
Instead of Not supported I might say "This is a no-op in this class." or something like that to avoid the expectation that this throws UnsupportedOperationException
--
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] fix more Javadoc [xerces-j]
Posted by "SingingBush (via GitHub)" <gi...@apache.org>.
SingingBush commented on code in PR #64:
URL: https://github.com/apache/xerces-j/pull/64#discussion_r2556714841
##########
src/org/apache/html/dom/HTMLDocumentImpl.java:
##########
@@ -614,23 +644,33 @@ public void close()
}
}
-
+ /**
+ * Write a string into the in-memory writer.
Review Comment:
ok, thanks. I'm updating this section 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] fix more Javadoc [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #64:
URL: https://github.com/apache/xerces-j/pull/64#discussion_r2555814108
##########
src/org/apache/html/dom/HTMLDocumentImpl.java:
##########
@@ -614,23 +644,33 @@ public void close()
}
}
-
+ /**
+ * Write a string into the in-memory writer.
Review Comment:
The in-memory writer is an implementation detail not exposed to the client so it shouldn't be referenced in the docs. Also, this doesn't really work here. It might in subclasses. Per class comment, "Note: <FRAMESET> documents are not supported at the moment, neither are direct document writing ({@link #open}, {@link #write})"
##########
src/org/apache/xerces/dom/NamedNodeMapImpl.java:
##########
@@ -328,14 +326,21 @@ public Node removeNamedItemNS(String namespaceURI, String name)
/**
* Cloning a NamedNodeMap is a DEEP OPERATION; it always clones
* all the nodes contained in the map.
+ *
+ * @param ownerNode the owner node that this node's children will be cloned to
+ * @return a collection of Nodes containing this node's children
*/
-
public NamedNodeMapImpl cloneMap(NodeImpl ownerNode) {
NamedNodeMapImpl newmap = new NamedNodeMapImpl(ownerNode);
newmap.cloneContent(this);
return newmap;
}
+ /**
+ * Override parent's method to set the ownerNode correctly.
+ *
+ * @param srcmap a NamedNodeMap who's nodes will be cloned into this NamedNodeMap's instance
Review Comment:
whose nodes
--
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] fix more Javadoc [xerces-j]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo merged PR #64:
URL: https://github.com/apache/xerces-j/pull/64
--
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