tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Mark Thomas <ma...@apache.org>
Subject Re: Outdated Servlet 3.0 Javadocs available on tomcat.apache.org
Date Wed, 01 Jun 2011 08:57:52 GMT
On 31/05/2011 21:48, Christopher Schultz wrote:
> All,
> 
> I just went to check something in the 3.0 Servlet API and the most
> convenient place I've found is on the Tomcat site. Unfortunately, it
> looks like it's out of date:
> 
> http://tomcat.apache.org/tomcat-7.0-doc/servletapi/index.html
> 
> Many of the 3.0 classes and methods are left undocumented (for example
> ServletContext.addFilter).
> 
> http://tomcat.apache.org/tomcat-7.0-doc/servletapi/javax/servlet/ServletContext.html#addFilter%28java.lang.String,%20java.lang.Class%29
> 
> It just looks like the API docs up there are from an old publication of
> the spec. The currently-available javadocs from the spec page are
> complete with comments, etc.

Those comments are part of CDDL licensed source code. My reading of
http://www.apache.org/legal/resolved.html#category-b is that we can't
copy the comments directly into our source code.

> What's the best way to update those javadocs? I'd be happy to do it.

Options that come to mind:
a) do nothing
b) add @see www.oracle.com tags where there are gaps
c) fill in the blanks based on our understanding of what the contract is
for each method

pid did provide some patches for this but there are still a lot of blanks.

Mark



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


Mime
View raw message