From owner-freebsd-java Wed Mar 7 10:11:18 2001 Delivered-To: freebsd-java@freebsd.org Received: from heinz.jollem.com (c104187.upc-c.chello.nl [212.187.104.187]) by hub.freebsd.org (Postfix) with ESMTP id 1460B37B71A for ; Wed, 7 Mar 2001 10:11:01 -0800 (PST) (envelope-from ernst@heinz.jollem.com) Received: (from ernst@localhost) by heinz.jollem.com (8.11.1/8.11.1) id f27I9kd01301; Wed, 7 Mar 2001 19:09:46 +0100 (CET) (envelope-from ernst) Date: Wed, 7 Mar 2001 19:09:46 +0100 From: Ernst de Haan To: Nate Williams Cc: FreeBSD Java mailing list Subject: Re: JDK install: Unpack source ? Message-ID: <20010307190946.A1272@c187104187.telekabel.chello.nl> References: <20010307113713.A2897@c187104187.telekabel.chello.nl> <15014.29052.149045.46268@nomad.yogotech.com> <20010307184758.A1163@c187104187.telekabel.chello.nl> <15014.30024.816436.328056@nomad.yogotech.com> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.2.5i In-Reply-To: <15014.30024.816436.328056@nomad.yogotech.com>; from nate@yogotech.com on Wed, Mar 07, 2001 at 10:52:08AM -0700 Sender: owner-freebsd-java@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org Hi Nate, > Why do you need to run javadoc? The documentation is provided complete > in another port, so you should never need to run javadoc on the base > stuff, AFAIK. We have a miscommunication. I am a Java software developer, I create Javadoc API documentation myself. This is what I run javadoc for. We use Ant to generate the Javadoc documentation during the build process. This is what the concerning target in the build file looks like: And up in the "init" section: Seems I don't include the JDK source code at the moment. But I do recall that I wanted to include it. Notice that I do include the source code for some other libraries. > > But while I'm writing this I'm wondering if (a) javadoc supports .jar > > files in the source path and (b) if I *really* need the source code > > for API docs generation, the Javadoc API docs should be enough. > > Now you're talking . :) No I mean for the generation of my API docs. You misunderstood me, I think =) > > And the times I need to check the source code, is usually because the > > API docs don't tell me half the story, or because I want to know what > > approach is used in the JDK, for example w.r.t. the implementation of > > some collection classes. > > Having done that for JDK1.0 and JDK1.1, I recommend you avoiding the > sources if at all possible. Sun *radically* changed the internals class > implementations from 1.0 -> 1.1 -> 1.2 -> 1.3. By looking at the > internals, you are more likely to depend on 'internal' behavior that > will no longer be relevant in subsuquent releases. Okay, I agree, but (a) for some AWT or Swing stuff there's hardly any choice but to check the source code if you want to get certain things done, and (b) when looking at the implementation of the collection classes, I don't use that information to assume a certain implementation, but just so that I can be sure that my implementation is 'better' (at least in the context of our project). > Again, sometimes you have very little choice, but too many times this > comes back to bite you. :( Yeah I know :) I've worked with JDK 1.0.2 too, and I *really* had to check the source code every now and then, because I couldn't get all information from the Javadoc comments. Good old days. Not. ;) -- Ernst To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-java" in the body of the message