hc-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sebb <seb...@gmail.com>
Subject Re: Missing @deprecated Javadoc tags
Date Sat, 14 Feb 2009 22:13:44 GMT
On 14/02/2009, Oleg Kalnichevski <olegk@apache.org> wrote:
> sebb wrote:
>
> > On 14/02/2009, Oleg Kalnichevski <olegk@apache.org> wrote:
> >
> > > sebb wrote:
> > >
> > >
> > > > There are a few files which contain @Deprecated annotations but which
> > > > don't have corresponding @deprecated Javadoc entries:
> > > >
> > > >
> > > >
> > >
> module-nio/src/main/java/org/apache/http/nio/entity/ByteArrayNIOEntity.java
> > >
> module-nio/src/main/java/org/apache/http/nio/entity/FileNIOEntity.java
> > >
> module-nio/src/main/java/org/apache/http/nio/entity/HttpNIOEntity.java
> > >
> module-nio/src/main/java/org/apache/http/nio/entity/StringNIOEntity.java
> > >
> module-nio/src/main/java/org/apache/http/nio/protocol/NHttpClientHandlerBase.java
> > >
> module-nio/src/main/java/org/apache/http/nio/protocol/NHttpServiceHandlerBase.java
> > >
> module-nio/src/main/java/org/apache/http/nio/util/ContentOutputBuffer.java
> > >
> > > > If classes or methods are @Deprecated, it would be useful to include
> > > > Javadoc @deprecated tags to say why and/or what to use instead.
> > > >
> > > >
> > > >
> > >  Unless I am missing something I think this happens pretty much
> > > automatically. All these classes and methods are marked deprecated in
> > > Javadocs.
> > >
> >
> > But AFAIK the @Deprecated annotation does not allow for comments to be
> > added to the Javadoc.
> >
> > The Javadoc @deprecated tag does allow for comments, so one can
> > describe what the user should do about the deprecation.
> >
> >
>
>  Makes sense. I'll add Javadoc @deprecated tag to those classes
>

Thanks, I've seen the commit.
It's much clearer now.

>  Oleg
>
>
>
> >
> > >  Oleg
> > >
> > >  PS: Many thanks for having taken care of this chore.
> > >
> >
> > OK - it was mainly Perl that did the work...
> >
> >
> > >
> > > > S///
> > > >
> > > >
> > > >
> > >
> ---------------------------------------------------------------------
> > >
> > > > To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> > > > For additional commands, e-mail: dev-help@hc.apache.org
> > > >
> > > >
> > > >
> > >
> > >
> ---------------------------------------------------------------------
> > >  To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> > >  For additional commands, e-mail: dev-help@hc.apache.org
> > >
> > >
> > >
> >
> >
> ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
> > For additional commands, e-mail: dev-help@hc.apache.org
> >
> >
>
>
> ---------------------------------------------------------------------
>  To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
>  For additional commands, e-mail: dev-help@hc.apache.org
>
>

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


Mime
View raw message