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 bu...@apache.org on 2001/11/01 15:47:01 UTC

DO NOT REPLY [Bug 597] - JavaDoc for BaseMarkupSerializer defective

DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG 
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://nagoya.apache.org/bugzilla/show_bug.cgi?id=597>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND 
INSERTED IN THE BUG DATABASE.

http://nagoya.apache.org/bugzilla/show_bug.cgi?id=597

JavaDoc for BaseMarkupSerializer defective

gmarcy@us.ibm.com changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|RESOLVED                    |REOPENED
         Resolution|INVALID                     |
            Summary|_preroot Vector is not      |JavaDoc for
                   |serialized when calling     |BaseMarkupSerializer
                   |serialize(Element)          |defective



------- Additional Comments From gmarcy@us.ibm.com  2001-11-01 06:47 -------
Sigh...  Did anyone read the first sentence here ?

"In the description of BaseMarkupSerializer, which is extended by XMLSerializer, 
it is stated that serialize(Element) should be used when serializing a DOM 
tree."

While it is nice that we all are happy to agree that serialize(Element) should 
not be calling serializePreRoot(), it would have been nice if someone had 
looked into WHY the confusion existed in the first place.

In the BaseMarkupSerializer class JavaDoc, the "source" says:

DOM serializing is done by calling {@link #serialize} and SAX serializing ...

When run through "javadoc", this turns into the following text on the web site:

DOM serializing is done by calling serialize(org.w3c.dom.Element) and SAX 
serializing ...

It seems clear that the ambiguous unqualified @link directive picked out the 
first serialize signature it found, which happened to be for Element instead of 
Document.

P.S.  Please stop with the "we don't maintain the Xerces1 serializer" code 
and vague references to DOM L3 "load and save" serialization.  The former 
statement is false and the latter is in no way an acceptable replacement for the 
current serializer code.

---------------------------------------------------------------------
To unsubscribe, e-mail: xerces-j-dev-unsubscribe@xml.apache.org
For additional commands, e-mail: xerces-j-dev-help@xml.apache.org