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

Re: get/setDocumentURI in org.w3c.dom.Document

From: Norman Walsh <ndw@nwalsh.com>
Date: Fri, 08 Jun 2007 09:35:47 -0400
To: Bjoern Hoehrmann <derhoermi@gmx.net>
Cc: www-dom@w3.org
Message-ID: <87ps46o9fw.fsf@nwalsh.com>
/ Bjoern Hoehrmann <derhoermi@gmx.net> was heard to say:
| * Norman Walsh wrote:
|>As far as I can tell, something about the process that generated those
|>API files caused the documentation for each get* method to be
|>textually identical to each set* method. Is that not a bug?
|
| No, the Java bindings are automatically generated from the specification
| source code, which only documents attributes as attributes, not as indi-
| vidual methods. For attributes that are read/write you inevitably get in
| some cases odd documentation. I don't think it is feasible to write two
| versions of the text for all such attributes, and I don't see an easy
| way to automatically generate more suitable text.

That's unfortunate. I wonder if it would be possible to add an
explanation of the problem to the description of the class at the top
of the file? At least that way readers would know it was intentional
and not a documentation bug.

| There are indeed two mails from you in the archive, expect them to be
| addressed as the specification is being revised.

Right. Good. I sent one more simple typo in this morning, in a
separate message so that it would be easier to track. If others come
up, I'll make sure they get reported.

                                        Be seeing you,
                                          norm

-- 
Norman Walsh <ndw@nwalsh.com> | If you run after wit you will succeed
http://nwalsh.com/            | in catching folly.-- Montesquieu

Received on Friday, 8 June 2007 13:36:59 GMT

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