[weld-dev] CDI JavaDoc

[Gavin King]

I'm trying to find time, but distracted by this IBM stuff.

On Mon, Oct 19, 2009 at 5:17 PM, Pete Muir <pmuir at redhat.com> wrote:
> Yup, this is definitely something, now the spec is basically not going to
> change again, it is worth putting a lot time into.
>
> Gavin, are you able to take a lead on this?
>
> On 19 Oct 2009, at 20:34, Gavin King wrote:
>
>> OK, folks we got one big, important job before the spec can go final.
>> We need to re-do the JavaDoc for all the standard APIs.
>>
>> Each type needs a complete explanation (perhaps copy/paste from the
>> spec). The important stuff (everything except for exceptions) needs
>> examples. We need links between related types (things used together).
>> We also need to fix all the errors that currently exist.
>>
>> I think it's very, very important that this stuff be extremely
>> well-documented. For many developers, this javadoc will be their very
>> first contact with JSR-299!
>>
>> --
>> Gavin King
>> gavin.king at gmail.com
>> http://in.relation.to/Bloggers/Gavin
>> http://hibernate.org
>> http://seamframework.org
>> _______________________________________________
>> weld-dev mailing list
>> weld-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/weld-dev
>
>



-- 
Gavin King
gavin.king at gmail.com
http://in.relation.to/Bloggers/Gavin
http://hibernate.org
http://seamframework.org