You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Stefan Bodewig <bo...@apache.org> on 2011/07/25 10:19:11 UTC

[compress] Keep old Javadocs?

Hi all,

some components keep the Javadocs for older versions online in addition
to the ones of the current release.  In our case the Javadocs for 1.2
won't be too different from the ones of 1.1, so I don't think it is
worthwhile, but still I'd like to double check.

Does anybody want the Javadocs of Compress 1.1 online after 1.2 has been
released?

Stefan

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


Re: [compress] Keep old Javadocs?

Posted by Simone Tripodi <si...@apache.org>.
Hi Stefan!!!
I think that keeping old javadocs would have more sense when we
release major releases, for cases such as compress 1.1 -> 1.2, tags
like @since, @deprecated, ... are more than enough.
just my 2 cents, have a nice day!!!
Simo

http://people.apache.org/~simonetripodi/
http://www.99soft.org/



On Mon, Jul 25, 2011 at 10:19 AM, Stefan Bodewig <bo...@apache.org> wrote:
> Hi all,
>
> some components keep the Javadocs for older versions online in addition
> to the ones of the current release.  In our case the Javadocs for 1.2
> won't be too different from the ones of 1.1, so I don't think it is
> worthwhile, but still I'd like to double check.
>
> Does anybody want the Javadocs of Compress 1.1 online after 1.2 has been
> released?
>
> Stefan
>
> ---------------------------------------------------------------------
> 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


Re: [compress] Keep old Javadocs?

Posted by Niall Pemberton <ni...@gmail.com>.
On Mon, Jul 25, 2011 at 9:56 AM, Stefan Bodewig <bo...@apache.org> wrote:
> On 2011-07-25, <lu...@free.fr> wrote:
>
>> If the URL do include the version, then it would be better to keep old
>> version online, to avoid dangling links from external web pages, mail
>> archives or documentation.
>
> Good point, thanks Luc.  The Javadoc URLs for Compress currently don't
> contain a version number so there is no danger of breaking anything this
> time - need to keep it in mind when we tackle Compress2, though.

Other components have a "current release" url, which is just a symlink
to the last release. That way you can have the latest & greatest from
svn, along with a URL that doesn't change for the last release.

For example, in IO:

http://commons.apache.org/io/apidocs/index.html
http://commons.apache.org/io/api-release/index.html
http://commons.apache.org/io/api-2.0.1/index.html
http://commons.apache.org/io/api-1.4/index.html
...etc

Niall




> Stefan
>
> ---------------------------------------------------------------------
> 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


Re: [compress] Keep old Javadocs?

Posted by Stefan Bodewig <bo...@apache.org>.
On 2011-07-25, <lu...@free.fr> wrote:

> If the URL do include the version, then it would be better to keep old
> version online, to avoid dangling links from external web pages, mail
> archives or documentation.

Good point, thanks Luc.  The Javadoc URLs for Compress currently don't
contain a version number so there is no danger of breaking anything this
time - need to keep it in mind when we tackle Compress2, though.

Stefan

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


Re: [compress] Keep old Javadocs?

Posted by lu...@free.fr.
Hi Stefan,

----- Mail original -----
> Hi all,
> 
> some components keep the Javadocs for older versions online in
> addition
> to the ones of the current release.  In our case the Javadocs for 1.2
> won't be too different from the ones of 1.1, so I don't think it is
> worthwhile, but still I'd like to double check.
> 
> Does anybody want the Javadocs of Compress 1.1 online after 1.2 has
> been
> released?

If the URL do include the version, then it would be better to keep old version
online, to avoid dangling links from external web pages, mail archives or
documentation.

Luc

> 
> Stefan
> 
> ---------------------------------------------------------------------
> 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