File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
The moose likes Beginning Java and the fly likes javadoc problems Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "javadoc problems" Watch "javadoc problems" New topic

javadoc problems

Davy Kelly
Ranch Hand

Joined: Jan 12, 2004
Posts: 384
Hi everyone, I have not been in here for a while.


I am going over Jeff Langr's Agile Java, and I was doing the javadoc bit near the start. I have had help from Jeff, but I am really not getting the javadoc. He said my main problem is the classpath.


my question is this: How do I do it from the command prompt?

this is what I have.

I have 2 folders under chessprogram called chess and pieces. The chessprogram is under agilejava which is directly in the c drive.

I was going to put a folder under chessprogram for the docs,

the import and package statements work fine, it also runs in junit fine, as Jeff's book is using junit all the way through as far as I can see.

I have tried many combinations to try to get this to work all bold was changed to all known combinations:
C:\agilejava\chessprogram\chess>javadoc -package -classpath "c:\agilejava;c:\junit3.8.1\junit.jar" chessprogram.chess.AllChessTests

what am I doing wrong?

my class path is set to:C:\junit3.8.1\junit.jar;c:\Program Files\Java\jdk1.5.0_03;c:\agilejava;

[ August 06, 2005: Message edited by: Davy Kelly ]

How simple does it have to be???
Davy Kelly
Ranch Hand

Joined: Jan 12, 2004
Posts: 384
I found what I was doing wrong.
I was looking for a class instead of the package.

How stupid of me

Casper Maxwell
Ranch Hand

Joined: Aug 04, 2005
Posts: 88

Why dont you use an IDE or Ant to simplify these types of jobs.

If you use Ant you will just add a <javadoc> target to your Ant script. Similar to <javadoc> there are other targets like <javac> and <java> which simplifies your work. Reading a book about Ant will be enough to learn it. (This was the case for me)

If you prefer an IDE: I am using Netbeans. After you create a project in Netbeans, if you right click on the project folder and select "Project Properties", then you have an option to customize your settings for javadoc tool. It is so easy.

But i highly reccomend you to switch to Ant at first instead of an IDE (if you like learning new and valuable things) as soon as possible. Writing code for Java without Ant seems like developing on Linux without automated tools like Make!

Although this is not a direct answer for your question. I hope this will help for your current and future problems.
Davy Kelly
Ranch Hand

Joined: Jan 12, 2004
Posts: 384
why I am not using it is because I am going through a book that is not using it.

I can understand your opinion, and I have used ntebeans before, but I disliked it.

thanks anyway.

Rick O'Shay
Ranch Hand

Joined: Sep 19, 2004
Posts: 531
Davvy, no finer book was ever written on the basics of Java programming and it does so with entirely up-to-date methods and current language features. All of the material can be done and should be done withou an IDE.

You will be able to boost your productivity substantially with an IDE in conjunction with build tools in the Ant family but you need a foundation. Until that foundation is in place the IDE just accelerates the generation of crap in higher volume
I agree. Here's the link:
subject: javadoc problems
jQuery in Action, 3rd edition