geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jeff Genender <jgenen...@apache.org>
Subject Re: specs and javadoc question
Date Tue, 07 Mar 2006 23:04:26 GMT


John Sisson wrote:
> We shouldn't retype the comments in the XSD just like the javadoc in the
> spec.  You are welcome to type your own original comments.

This is debatable for XSDs.  We currently seem to be using a lot of XSDs
verbatim for the SPECs, so we need an official statement on this.

> 
> Thanks,
> 
> John
> 
> Bill Dudney wrote:
>> Hi All,
>>
>> I think this must have gotten lost in the traffic over the weekend.
>>
>> Anyone know if I should/have to retype all the documentation comments
>> in the XSD?
>>
>> Thanks,
>>
>>
>> Bill Dudney
>> MyFaces - myfaces.apache.org
>>
>>
>> On Mar 5, 2006, at 6:50 AM, Bill Dudney wrote:
>>
>>> One other question - the documentation comments in the XML schema for
>>> the spec? Should I type in these comments or leave them out?
>>>
>>> Thanks,
>>>
>>> -bd-
>>>
>>> On Mar 3, 2006, at 1:00 PM, Dain Sundstrom wrote:
>>>
>>>> BTW add a jira for this, so everyone knows you are working on it.
>>>>
>>>> -dain
>>>>
>>>> On Mar 3, 2006, at 10:02 AM, Bill Dudney wrote:
>>>>
>>>>> Hi All,
>>>>>
>>>>> Thanks for the comments.
>>>>>
>>>>> Dain: Yeah its not copying out of the pdf but simply typing, hardly
>>>>> feels like original work though so even though I'm not copying, it
>>>>> sure feels like it. :-)
>>>>>
>>>>> I'll leave the comments out and post a patch after I get one more
>>>>> pass over it (~early next week).
>>>>>
>>>>> TTFN,
>>>>>
>>>>>
>>>>> Bill Dudney
>>>>> MyFaces - myfaces.apache.org
>>>>>
>>>>> On Mar 3, 2006, at 10:43 AM, Dain Sundstrom wrote:
>>>>>
>>>>>> On Mar 3, 2006, at 9:37 AM, David Jencks wrote:
>>>>>>
>>>>>>> On Mar 3, 2006, at 9:10 AM, Bill Dudney wrote:
>>>>>>>
>>>>>>>> Hi All,
>>>>>>>>
>>>>>>>> I've started getting ready for JSF 1.2 and figured that a
good
>>>>>>>> place for the api jar to land is the uber spec project @
G for
>>>>>>>> JavaEE 5.
>>>>>>>>
>>>>>>>> I'm most of the way there for Servlet 2.5 and JSP 2.1 but
I was
>>>>>>>> wondering about javadoc. Does anyone know what the rules
are
>>>>>>>> regarding javadoc in the spec code? I've just been doing
a
>>>>>>>> straight copy/typing of the api and leaving out the javadoc.
But
>>>>>>>> looking back at the Servlet 2.4 and JSP 2.0 spec modules
all the
>>>>>>>> javadoc is there.
>>>>>>
>>>>>> No "copying" only "typing" is allowed.
>>>>>>
>>>>>>>> I'd like to submit the patch for Servlet 2.5 and JSP 2.1
in the
>>>>>>>> next week or so. If anyone knows the definitive answer (or
since
>>>>>>>> we are not lawyers as close to definitive as possible:) I'd
love
>>>>>>>> to hear it.
>>>>>>>
>>>>>>> I have not been copying the javadocs into the specs I have worked
>>>>>>> on.  I think that our servlet 2.4 and jsp 2.0 specs are copied
>>>>>>> from tomcat where they were IIUC donated complete with javadocs
>>>>>>> by sun.  I think leaving out the javadoc is the wisest course.
>>>>>>
>>>>>> Yes, the javadoc comments are owned by Sun.  If you would like to
>>>>>> write your own *original* javadoc comments, that would be cool,
>>>>>> but not necessary.
>>>>>>
>>>>>> -dain
>>>>
>>>
>>
>>

Mime
View raw message