javadoc not showing expected comments

Hopefully, someone else will have had this problem. For some reason, the following code does not show what I was expecting.

What I did see was a listing of methods, parameters, and return (just the first line of the method). This info was in a summary table also.

I expected to see the class description, etc when I look at the AVLTree link from the AllClasses.html. Also, I wasn't seeing the class level attribute descriptions at all. I wasn't seeing the method descriptions, parameters, return, or throws text either. Was I looking in the wrong place? Did I forget a tag during compilation? I saw the same thing when I opened the AVLTree.html directly. I tried clicking the link to AVLTree in the .html, and it didn't show me more than I saw from the AVLTree.html. I compiled using:

javac Project4.java (this is my main class)

I used the following to create javadocs:

javadoc *.java

/**

*Description: This class inserts item into avl tree, deletes items, prints the tree, prints the payroll, rebalances, and other needed operations.

*Purpose: This class implements an avl tree.

*Date: 12/15/2001

*Project: 4

*File: AVLTree.java

*Other Needed Files: BiTNode.java, Compare.java, TreeOperation.java, PayrollOperation.java, NameCompare.java, TitleCompare.java, BiTNode.java, Employee.java.

*

*@ author Mich

*@ version 1.0, 12/15/2001

*/

import java.util.Vector;

import java.io.*;

public class AVLTree {

/**

*count The number of items in tree

*root The root of the tree

*/

private int count;

private BiTNode root;

public AVLTree() {

/**

*Purpose:This method is a constructor

*/

root = null;

count = 0;

}

public void operate(TreeOperation o) throws IOException {

/**

*Purpose:Calls recursive method operate.

*

*@throws IOException indicates input or output problems

*/

operate(root,o);

}

//and so on

}

[2071 byte] By [mich_cl] at [2007-9-26 15:32:24]
# 1

You've run into a common mistake, which is to put the import statement after the class comment. The comment must go immediately before its corresponding declaration, without an import statement in between.

This is listed along with other common mistakes in the Javadoc FAQ:

http//java.sun.com/j2se/javadoc/faq.html#missingclasscomments

In the method bodies, you've put the doc comments after the declaration, which is also incorrect.

For a proper example, see:

http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#examples

-Doug Kramer

Javadoc team

dkramer at 2007-7-2 18:20:55 > top of Java-index,Developer Tools,Debugging and Profiling Tool APIs...