users@jsr311.java.net

Re: Missing Javadoc

From: cowwoc <cowwoc_at_bbs.darktech.org>
Date: Wed, 17 Dec 2008 18:23:09 -0500

        Why am I getting that sinking feeling again? ... It could be this:
http://www.netbeans.org/issues/show_bug.cgi?id=122930

        I'll check it out and report back here shortly.

Gili

Marc Hadley wrote:
> I wasn't aware that there was missing javadoc that's why I'm asking you
> to be specific.
>
> Where are you reading the javadoc, the 1.0 doc explicitly states that
> tag(String) adds a strong entity tag as does the String constructor for
> EntityTag ?
>
> Thanks
> Marc
>
> On Dec 17, 2008, at 5:05 PM, cowwoc <cowwoc_at_bbs.darktech.org> wrote:
>
>> Marc,
>>
>> Is this okay? https://jsr311.dev.java.net/issues/show_bug.cgi?id=60
>>
>> PS: I know you're asking for a specific problem, but I believe that
>> shipping a public API with missing Javadoc is problematic. When I am
>> faced with methods without Javadoc it forces me to peek into the
>> source-code, which is neither productive nor safe from a specification
>> point of view. Any plans to rectify this? Most IDEs will issue
>> warnings on missing Javadoc. Simply turn this on and follow the trail :)
>>
>> Gili
>>
>> Marc Hadley wrote:
>>> On Dec 17, 2008, at 3:56 PM, Marc Hadley <Marc.Hadley_at_Sun.COM> wrote:
>>>> Yes please file a bug.
>>>>
>>> BTW, the more specific, the better.
>>> Thanks again
>>> Marc
>>>>
>>>> On Dec 17, 2008, at 3:50 PM, cowwoc <cowwoc_at_bbs.darktech.org> wrote:
>>>>
>>>>> Hi,
>>>>>
>>>>> Does anyone plan on documenting all JSR311 methods missing Javadoc?
>>>>> For example, it isn't clear what kind of EntityTag
>>>>> ResponseBuilder.tag(String) builds. Is it weak or strong? A lot of
>>>>> these things should be documented and the best way to do so is to
>>>>> fill in the missing Javadoc. Should I file a bug report against this?
>>>>>
>>>>> Gili
>>>>>
>>>>> ---------------------------------------------------------------------
>>>>> To unsubscribe, e-mail: users-unsubscribe_at_jsr311.dev.java.net
>>>>> For additional commands, e-mail: users-help_at_jsr311.dev.java.net
>>>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: users-unsubscribe_at_jsr311.dev.java.net
>>> For additional commands, e-mail: users-help_at_jsr311.dev.java.net
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: users-unsubscribe_at_jsr311.dev.java.net
>> For additional commands, e-mail: users-help_at_jsr311.dev.java.net
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe_at_jsr311.dev.java.net
> For additional commands, e-mail: users-help_at_jsr311.dev.java.net