You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by Yoav Shapira <yo...@MIT.EDU> on 2005/07/26 23:05:56 UTC

RE: tomcat API doc, where?

Hi,
Download eith ther .zip or .tar.gz base distro: you probably downloaded the
.exe.  You can also just look at the ones on the web site: go to
http://jakarta.apache.org/tomcat, pick the Documentation link for your
version, and scroll down near the bottom of the left-hand menu.

Yoav Shapira
System Design and Management Fellow
MIT Sloan School of Management
Cambridge, MA
yoavs@computer.org / yoavsh@sloan.mit.edu

> -----Original Message-----
> From: Andreas Schenk [mailto:dr.andreas.schenk@gmx.net]
> Sent: Tuesday, July 26, 2005 5:41 PM
> To: tomcat-dev@jakarta.apache.org
> Subject: tomcat API doc, where?
> 
> Hi,
> 
> if I try to get the API doc, I always end up with
> 
> Tomcat's internal javadoc is no longer installed by default. Download and
> install the "fulldocs" package to get it. You can also access the javadoc
> online in the Tomcat documentation bundle.
> 
> Where can I download the API doc? Can you give me a link to the "fulldocs"
> package?
> 
> Thanks in advance,
> 
> Andreas Schenk
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org



RE: tomcat API doc, where?

Posted by Yoav Shapira <yo...@MIT.EDU>.
Hi,
Alright, I've regenerated the docs for 5.5.10, minus
JSSE15SocketFactory.java's JavaDoc, and posted them.  The live site update
will take 4-6 hours as usual (usual for the past few months, really).

I'll go update build.xml's javadoc target to ignore this file, so that'll be
fixed for 5.5.11.

5.5.10 stability vote next weekend, btw, unless someone finds a showstopper
beforehand.

Yoav Shapira
System Design and Management Fellow
MIT Sloan School of Management
Cambridge, MA
yoavs@computer.org / yoavsh@sloan.mit.edu

> -----Original Message-----
> From: Remy Maucherat [mailto:remm@apache.org]
> Sent: Tuesday, July 26, 2005 6:39 PM
> To: Tomcat Developers List
> Subject: Re: tomcat API doc, where?
> 
> Yoav Shapira wrote:
> > Hi,
> > This is actually a bit more interesting than I thought ;)
> > jakarta-tomcat-
> connectors/util/java/org/apache/tomcat/util/net/JSSE15SocketF
> > actory.java breaks the JDK 1.4 javadoc (lines 33 and 62 have fatal
> JavaDoc
> > errors).  Since we build with JDK 1.4, the Catalina API JavaDocs weren't
> > generated.
> >
> > I've recorded this in Bugzilla as 35880,
> > http://issues.apache.org/bugzilla/show_bug.cgi?id=35880.  The question
> is
> > what's the best fix.  Should we exclude that file (or that whole
> package)
> > from the JavaDoc target?
> 
> I don't see any choice other than to filter out any Java 5 code at the
> moment.
> 
> Rémy
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org



Re: tomcat API doc, where?

Posted by Remy Maucherat <re...@apache.org>.
Yoav Shapira wrote:
> Hi,
> This is actually a bit more interesting than I thought ;)
> jakarta-tomcat-connectors/util/java/org/apache/tomcat/util/net/JSSE15SocketF
> actory.java breaks the JDK 1.4 javadoc (lines 33 and 62 have fatal JavaDoc
> errors).  Since we build with JDK 1.4, the Catalina API JavaDocs weren't
> generated.  
> 
> I've recorded this in Bugzilla as 35880,
> http://issues.apache.org/bugzilla/show_bug.cgi?id=35880.  The question is
> what's the best fix.  Should we exclude that file (or that whole package)
> from the JavaDoc target?

I don't see any choice other than to filter out any Java 5 code at the 
moment.

Rémy

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


RE: tomcat API doc, where?

Posted by Yoav Shapira <yo...@MIT.EDU>.
Hi,
This is actually a bit more interesting than I thought ;)
jakarta-tomcat-connectors/util/java/org/apache/tomcat/util/net/JSSE15SocketF
actory.java breaks the JDK 1.4 javadoc (lines 33 and 62 have fatal JavaDoc
errors).  Since we build with JDK 1.4, the Catalina API JavaDocs weren't
generated.  

I've recorded this in Bugzilla as 35880,
http://issues.apache.org/bugzilla/show_bug.cgi?id=35880.  The question is
what's the best fix.  Should we exclude that file (or that whole package)
from the JavaDoc target?

Yoav Shapira
System Design and Management Fellow
MIT Sloan School of Management
Cambridge, MA
yoavs@computer.org / yoavsh@sloan.mit.edu

> -----Original Message-----
> From: Jean-frederic Clere [mailto:jfclere@telefonica.net]
> Sent: Tuesday, July 26, 2005 5:14 PM
> To: Tomcat Developers List
> Subject: Re: tomcat API doc, where?
> 
> Yoav Shapira wrote:
> 
> >Hi,
> >Download eith ther .zip or .tar.gz base distro: you probably downloaded
> the
> >.exe.  You can also just look at the ones on the web site: go to
> >http://jakarta.apache.org/tomcat, pick the Documentation link for your
> >version, and scroll down near the bottom of the left-hand menu.
> >
> >
> That does not work with 5.5 (See
> http://jakarta.apache.org/tomcat/tomcat-5.5-
> doc/catalina/docs/api/index.html).
> 
> >Yoav Shapira
> >System Design and Management Fellow
> >MIT Sloan School of Management
> >Cambridge, MA
> >yoavs@computer.org / yoavsh@sloan.mit.edu
> >
> >
> >
> >>-----Original Message-----
> >>From: Andreas Schenk [mailto:dr.andreas.schenk@gmx.net]
> >>Sent: Tuesday, July 26, 2005 5:41 PM
> >>To: tomcat-dev@jakarta.apache.org
> >>Subject: tomcat API doc, where?
> >>
> >>Hi,
> >>
> >>if I try to get the API doc, I always end up with
> >>
> >>Tomcat's internal javadoc is no longer installed by default. Download
> and
> >>install the "fulldocs" package to get it. You can also access the
> javadoc
> >>online in the Tomcat documentation bundle.
> >>
> >>Where can I download the API doc? Can you give me a link to the
> "fulldocs"
> >>package?
> >>
> >>Thanks in advance,
> >>
> >>Andreas Schenk
> >>
> >>---------------------------------------------------------------------
> >>To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
> >>For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org
> >>
> >>
> >
> >
> >
> >
> >------------------------------------------------------------------------
> >
> >---------------------------------------------------------------------
> >To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
> >For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org
> >
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org



RE: tomcat API doc, where?

Posted by Yoav Shapira <yo...@MIT.EDU>.
Hi,
That's unfortunate.  I'll go fix it right now.

Yoav Shapira
System Design and Management Fellow
MIT Sloan School of Management
Cambridge, MA
yoavs@computer.org / yoavsh@sloan.mit.edu

> -----Original Message-----
> From: Jean-frederic Clere [mailto:jfclere@telefonica.net]
> Sent: Tuesday, July 26, 2005 5:14 PM
> To: Tomcat Developers List
> Subject: Re: tomcat API doc, where?
> 
> Yoav Shapira wrote:
> 
> >Hi,
> >Download eith ther .zip or .tar.gz base distro: you probably downloaded
> the
> >.exe.  You can also just look at the ones on the web site: go to
> >http://jakarta.apache.org/tomcat, pick the Documentation link for your
> >version, and scroll down near the bottom of the left-hand menu.
> >
> >
> That does not work with 5.5 (See
> http://jakarta.apache.org/tomcat/tomcat-5.5-
> doc/catalina/docs/api/index.html).
> 
> >Yoav Shapira
> >System Design and Management Fellow
> >MIT Sloan School of Management
> >Cambridge, MA
> >yoavs@computer.org / yoavsh@sloan.mit.edu
> >
> >
> >
> >>-----Original Message-----
> >>From: Andreas Schenk [mailto:dr.andreas.schenk@gmx.net]
> >>Sent: Tuesday, July 26, 2005 5:41 PM
> >>To: tomcat-dev@jakarta.apache.org
> >>Subject: tomcat API doc, where?
> >>
> >>Hi,
> >>
> >>if I try to get the API doc, I always end up with
> >>
> >>Tomcat's internal javadoc is no longer installed by default. Download
> and
> >>install the "fulldocs" package to get it. You can also access the
> javadoc
> >>online in the Tomcat documentation bundle.
> >>
> >>Where can I download the API doc? Can you give me a link to the
> "fulldocs"
> >>package?
> >>
> >>Thanks in advance,
> >>
> >>Andreas Schenk
> >>
> >>---------------------------------------------------------------------
> >>To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
> >>For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org
> >>
> >>
> >
> >
> >
> >
> >------------------------------------------------------------------------
> >
> >---------------------------------------------------------------------
> >To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
> >For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org
> >
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org



Re: tomcat API doc, where?

Posted by Jean-frederic Clere <jf...@telefonica.net>.
Yoav Shapira wrote:

>Hi,
>Download eith ther .zip or .tar.gz base distro: you probably downloaded the
>.exe.  You can also just look at the ones on the web site: go to
>http://jakarta.apache.org/tomcat, pick the Documentation link for your
>version, and scroll down near the bottom of the left-hand menu.
>  
>
That does not work with 5.5 (See 
http://jakarta.apache.org/tomcat/tomcat-5.5-doc/catalina/docs/api/index.html).

>Yoav Shapira
>System Design and Management Fellow
>MIT Sloan School of Management
>Cambridge, MA
>yoavs@computer.org / yoavsh@sloan.mit.edu
>
>  
>
>>-----Original Message-----
>>From: Andreas Schenk [mailto:dr.andreas.schenk@gmx.net]
>>Sent: Tuesday, July 26, 2005 5:41 PM
>>To: tomcat-dev@jakarta.apache.org
>>Subject: tomcat API doc, where?
>>
>>Hi,
>>
>>if I try to get the API doc, I always end up with
>>
>>Tomcat's internal javadoc is no longer installed by default. Download and
>>install the "fulldocs" package to get it. You can also access the javadoc
>>online in the Tomcat documentation bundle.
>>
>>Where can I download the API doc? Can you give me a link to the "fulldocs"
>>package?
>>
>>Thanks in advance,
>>
>>Andreas Schenk
>>
>>---------------------------------------------------------------------
>>To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
>>For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org
>>    
>>
>
>
>  
>
>------------------------------------------------------------------------
>
>---------------------------------------------------------------------
>To unsubscribe, e-mail: tomcat-dev-unsubscribe@jakarta.apache.org
>For additional commands, e-mail: tomcat-dev-help@jakarta.apache.org
>


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