W3C home > Mailing lists > Public > www-dom@w3.org > April to June 2001

Re: Java doc bugs

From: Edwin Goei <edwingo@sun.com>
Date: Thu, 21 Jun 2001 10:58:25 -0700
Message-ID: <3B3235C1.42292899@sun.com>
To: Philippe Le Hegaret <plh@w3.org>
CC: www-dom@w3.org, Jamie Ho <Jamie.Ho@sun.com>
Philippe Le Hegaret wrote:
> 
> This new version should fix the javadoc [1]:
> http://www.w3.org/2001/06/java-binding.zip
> 
> If the new Java bindings are ok, they will be integrated as an erratum.

Hi Philippe,

Yes, it fixes most of the bugs.  One bug that was not fixed is below:

  The description ( javadoc comments ) of the
org.w3c.dom.Node.getNodeValue() 
says 
that values returned by the method is described in some table :
  
  "public String getNodeValue() throws DOMException
  
     The value of this node, depending on its type; see the table above"
  
  But there is no such table either in the method's description or in
the 
description of the interface org.w3c.dom.Node.


See attached patch for a sample fix.  Thanks,

-Edwin
*** /java/pubs/ws/jamie-merlin/webrev/src/share/classes/org/w3c/dom/Node.java-  Wed Jun 20 17:38:55 2001
--- Node.java   Wed Jun 20 17:33:17 2001


*** 27,37 ****
   * specific <code>nodeType</code> (e.g., <code>nodeValue</code> for an 
   * <code>Element</code> or <code>attributes</code> for a <code>Comment</code>
   * ), this returns <code>null</code>. Note that the specialized interfaces 
   * may contain additional and more convenient mechanisms to get and set the 
   * relevant information.
!  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113'>Document Object Model (DOM) Level 2 Core Specification</a>.
   */
  public interface Node {
      // NodeType
      /**
       * The node is an <code>Element</code>.
--- 27,108 ----
   * specific <code>nodeType</code> (e.g., <code>nodeValue</code> for an 
   * <code>Element</code> or <code>attributes</code> for a <code>Comment</code>
   * ), this returns <code>null</code>. Note that the specialized interfaces 
   * may contain additional and more convenient mechanisms to get and set the 
   * relevant information.
!  * <P>The values of <CODE>nodeName</CODE>, <CODE>nodeValue</CODE>, and 
!  * <CODE>attributes</CODE> vary according to the node type as follows: 
!  * <CENTER>
!  * <TABLE border=1>
!  * <TBODY>
!  * <TR>
!  *   <TD bgColor=#ccccff>Node Type</TD>
!  *   <TD bgColor=#ccccff>nodeName</TD>
!  *   <TD bgColor=#ccccff>nodeValue</TD>
!  *   <TD bgColor=#ccccff>attributes</TD></TR>
!  * <TR>
!  *   <TD>Element</TD>
!  *   <TD>tagName</TD>
!  *   <TD>null</TD>
!  *   <TD>NamedNodeMap</TD></TR>
!  * <TR>
!  *   <TD>Attr</TD>
!  *   <TD>name of attribute</TD>
!  *   <TD>value of attribute</TD>
!  *   <TD>null</TD></TR>
!  * <TR>
!  *   <TD>Text</TD>
!  *   <TD>#text</TD>
!  *   <TD>content of the text node</TD>
!  *   <TD>null</TD></TR>
!  * <TR>
!  *   <TD>CDATASection</TD>
!  *   <TD>#cdata-section</TD>
!  *   <TD>content of the CDATA Section</TD>
!  *   <TD>null</TD></TR>
!  * <TR>
!  *   <TD>EntityReference</TD>
!  *   <TD>name of entity referenced</TD>
!  *   <TD>null</TD>
!  *   <TD>null</TD></TR>
!  * <TR>
!  *   <TD>Entity</TD>
!  *   <TD>entity name</TD>
!  *   <TD>null</TD>
!  *   <TD>null</TD></TR>
!  * <TR>
!  *   <TD>ProcessingInstruction</TD>
!  *   <TD>target</TD>
!  *   <TD>entire content excluding the target</TD>
!  *   <TD>null</TD></TR>
!  * <TR>
!  *   <TD>Comment</TD>
!  *   <TD>#comment</TD>
!  *   <TD>content of the comment</TD>
!  *   <TD>null</TD></TR>
!  * <TR>
!  *   <TD>Document</TD>
!  *   <TD>#document</TD>
!  *   <TD>null</TD>
!  *   <TD>null</TD></TR>
!  * <TR>
!  *   <TD>DocumentType</TD>
!  *   <TD>document type name</TD>
!  *   <TD>null</TD>
!  *   <TD>null</TD></TR>
!  * <TR>
!  *   <TD>DocumentFragment</TD>
!  *   <TD>#document-fragment</TD>
!  *   <TD>null</TD>
!  *   <TD>null</TD></TR>
!  * <TR>
!  *   <TD>Notation</TD>
!  *   <TD>notation name</TD>
!  *   <TD>null</TD>
!  *   <TD>null</TD></TR></TBODY></TABLE></CENTER>
!  * <p>
!  * See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113'>Document Object Model (DOM) Level 2 Core Specification</a>.
   */
  public interface Node {
      // NodeType
      /**
       * The node is an <code>Element</code>.
Received on Thursday, 21 June 2001 13:57:56 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Friday, 22 June 2012 06:13:48 GMT