commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gary Gregory <GGreg...@seagullsoftware.com>
Subject RE: [lang] v3.0 @since
Date Sat, 27 Mar 2010 23:05:27 GMT
Since multiple @since tags are allowed and are treated like multiple @author tags, what about
making use of that? For example:

...
     * @since 2.0
     * @since 3.0 
     */
    public static String capitalize(CharSequence cs) {
...

Or maybe:

     * @since 2.0
     * @since 3.0 changed from capitalize(String) to capitalize(CharSequence)

Or something like that, since the @since text is free form.

Gary Gregory
Senior Software Engineer
Seagull Software
email: ggregory@seagullsoftware.com
email: ggregory@apache.org
www.seagullsoftware.com 



> -----Original Message-----
> From: Henri Yandell [mailto:flamefew@gmail.com]
> Sent: Saturday, March 27, 2010 14:49
> To: Commons Developers List
> Subject: Re: [lang] v3.0 @since
> 
> I think so. If a recompile would make it work, then no need to update
> the @since. It would be lovely to say @improved 3.0; but at the end of
> the day I think we'll have to rely on separate documentation to handle
> that.
> 
> On Sun, Mar 7, 2010 at 12:22 AM, Gary Gregory
> <GGregory@seagullsoftware.com> wrote:
> > Fair enough.
> >
> > What about APIs that change from, for example, String to
> CharSequence, should these stay with the same @since tags, even if the
> Java version for the project of the @since version did not include the
> class CharSequence.
> >
> > Gary
> >
> >> -----Original Message-----
> >> From: Henri Yandell [mailto:flamefew@gmail.com]
> >> Sent: Saturday, March 06, 2010 19:23
> >> To: Commons Developers List
> >> Subject: Re: [lang] v3.0 @since
> >>
> >> I think it does.
> >>
> >> The choice of a new package name was a workaround rather than a
> >> declaration of a different package, so the @since's still have
> value.
> >>
> >> Hen
> >>
> >> On Sat, Mar 6, 2010 at 5:13 PM, Gary Gregory
> >> <GGregory@seagullsoftware.com> wrote:
> >> > Looking at trunk I see that the @since tags are still there. Since
> the
> >> package o.a.c.lang3 is new, does it make sense to have @since tags
> OTHER than
> >> 3.0 if any?
> >> >
> >> > Gary Gregory
> >> > Senior Software Engineer
> >> > Seagull Software
> >> > email: ggregory@seagullsoftware.com
> >> > email: ggregory@apache.org
> >> > www.seagullsoftware.com
> >> >
> >> >
> >> > ------------------------------------------------------------------
> ---
> >> > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> >> > For additional commands, e-mail: dev-help@commons.apache.org
> >> >
> >> >
> >>
> >> --------------------------------------------------------------------
> -
> >> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> >> For additional commands, e-mail: dev-help@commons.apache.org
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > For additional commands, e-mail: dev-help@commons.apache.org
> >
> >
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message