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

Re: Java doc bugs

From: Edwin Goei <Edwin.Goei@eng.sun.com>
Date: Thu, 21 Jun 2001 14:42:38 -0700
Message-ID: <3B326A4E.DB7E8931@eng.sun.com>
To: Philippe Le Hegaret <plh@w3.org>
CC: www-dom@w3.org, Jamie Ho <Jamie.Ho@Sun.COM>
Philippe Le Hegaret wrote:
> Here is a new try:
> http://www.w3.org/2001/06/java-binding.2.zip
> Since the Java sources are generated, I had to change the DOM scripts
> to generate the documentation of Node.
> It fixed the same problem in the Document interface (createElementNS,
> createAttributeNS). Also, the description of importNode wasn't
> "well-formed".

Thanks, it looks better.  From a quick scan, I've noticed these items:

  + The url href mentioned in more than one file does not exist:

  + It looks like the get/setXXX() methods have the same javadoc, which
may be suboptimal b/c for example, Attr#getValue() says it can throw a
NO_MODIFICATION_ALLOWED_ERR while the DOM spec says that only the
Attr#setValue() method should do this.  In addition, the other javadoc
comments may sound somewhat awkward.  Since it sounds like you are
auto-generating the java bindings, it may be difficult to fix this.  So,
I will leave it up to you as to whether it is worth fixing this to avoid
user complaints.

Received on Thursday, 21 June 2001 17:42:43 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 20 October 2015 10:46:08 UTC