[jdom-interest] Push toward a 1.0 API

[Elliotte Rusty Harold]

At 6:39 PM -0700 4/9/02, Jason Hunter wrote:
>I think we're at a good point now where we can, with just a little push,
>define the JDOM 1.0 API.  There may be a little work after that point to
>have it fully implemented, and we're going to have to run through the
>JCP process, but I don't see any API issues outstanding that would keep
>us from defining the 1.0 API.
>

I'm currently working my way through the entire API as part of 
writing the JDOM chapters for my next book. I find that this brings 
out a whole different set of concerns than is often caught by either 
users or developers. I hope to have this finished within the next 
couple of weeks.

I do think it would be useful to have several people commit to doing 
reviews of both the code base itself and the JavaDocs. They don't 
necessarily have to be the same people. The goal would be to read 
through the entire code base  with an eye toward whether code is 
doing what it says and says what it's doing and whether it should 
indeed be doing what it says or what it is. JDOM's still small enough 
that this seems plausible. Once we go to 1.0, fixing even obvious 
mistakes in things like exception signatures, naming conventions, and 
return types is going to be a lot harder.

Here's another one: in XMLOutputter should the setNewlines() method 
be setNewLines()? I'm about 60/40 on this one. I do occasionally see 
newline written as a single word but rarely as a plural, and the 
JavaDoc does use "new lines" (two words)
-- 

+-----------------------+------------------------+-------------------+
| Elliotte Rusty Harold | elharo at metalab.unc.edu | Writer/Programmer |
+-----------------------+------------------------+-------------------+
|          The XML Bible, 2nd Edition (Hungry Minds, 2001)           |
|             http://www.cafeconleche.org/books/bible2/              |
|   http://www.amazon.com/exec/obidos/ISBN=0764547607/cafeaulaitA/   |
+----------------------------------+---------------------------------+
|  Read Cafe au Lait for Java News:  http://www.cafeaulait.org/      |
|  Read Cafe con Leche for XML News: http://www.cafeconleche.org/    |
+----------------------------------+---------------------------------+