You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jdo-dev@db.apache.org by Michelle Caisse <Mi...@Sun.COM> on 2007/06/16 03:41:47 UTC
Re: Spec pages for annotations
Hi Craig,
This looks good and is appropriate for the spec, though it is not nearly
as user friendly as the JPOX annotation doc page
http://www.jpox.org/docs/1_2/jdo/annotations.html. The more compact
tabular format makes it much easier to scan and find information. Maybe
you could add some tables at the end of the chapter, time permitting.
How are the xml metadata overrides supposed to work? Globally, within
jdo/orm sets, element by element ...?
-- Michelle
Craig L Russell wrote:
> I'm thinking of concentrating my energy in making sure the javadoc
> for annotations is correct and then publishing the spec taking the
> information directly from the sources. Please take a look at the
> attached sample and see if this looks like a good way to present the
> information.
>
> Between the section heading and the source code I would add any notes
> or comments.
>
> There are other, more labor-intensive, ways of presenting this but I
> need to make sure the javadoc is correct anyway.
>
> Please let me know your thoughts...
>
> Craig
>
> Craig Russell
> Architect, Sun Java Enterprise System http://java.sun.com/products/jdo
> 408 276-5638 mailto:Craig.Russell@sun.com
> P.S. A good JDO? O, Gasp!
Re: Spec pages for annotations
Posted by Andy Jefferson <an...@jpox.org>.
Hi Craig,
> So how was this page generated? Is it directly from the javadoc? The
> only difference between a javadoc format and this is the examples.
the page in our docs wasn't generated from the javadocs (unfortunately). It is
in XDOC format (Maven1/Velocity docs format), and was generated manually.
You're welcome to take it, or parts of it, as you wish for the spec.
The source is at
http://jpox.cvs.sourceforge.net/jpox/JPOX/xdocs/1_2/jdo/
--
Andy (Java Persistent Objects - http://www.jpox.org)
Re: Spec pages for annotations
Posted by Craig L Russell <Cr...@Sun.COM>.
So how was this page generated? Is it directly from the javadoc? The
only difference between a javadoc format and this is the examples.
I'd love to be able to just drop this page into the spec.
Craig
On Jun 15, 2007, at 6:41 PM, Michelle Caisse wrote:
> Hi Craig,
>
> This looks good and is appropriate for the spec, though it is not
> nearly as user friendly as the JPOX annotation doc page http://
> www.jpox.org/docs/1_2/jdo/annotations.html. The more compact
> tabular format makes it much easier to scan and find information.
> Maybe you could add some tables at the end of the chapter, time
> permitting.
>
> How are the xml metadata overrides supposed to work? Globally,
> within jdo/orm sets, element by element ...?
>
> -- Michelle
>
> Craig L Russell wrote:
>
>> I'm thinking of concentrating my energy in making sure the
>> javadoc for annotations is correct and then publishing the spec
>> taking the information directly from the sources. Please take a
>> look at the attached sample and see if this looks like a good way
>> to present the information.
>>
>> Between the section heading and the source code I would add any
>> notes or comments.
>>
>> There are other, more labor-intensive, ways of presenting this but
>> I need to make sure the javadoc is correct anyway.
>>
>> Please let me know your thoughts...
>>
>> Craig
>>
>> Craig Russell
>> Architect, Sun Java Enterprise System http://java.sun.com/products/
>> jdo
>> 408 276-5638 mailto:Craig.Russell@sun.com
>> P.S. A good JDO? O, Gasp!
>
>
Craig Russell
Architect, Sun Java Enterprise System http://java.sun.com/products/jdo
408 276-5638 mailto:Craig.Russell@sun.com
P.S. A good JDO? O, Gasp!