Explore the Javadoc output
I'm giving an API documentation workshop in San Francisco, California, on November 19, 2019. Check it out on EventBrite and register today to receive a $100 early bird discount.
The Javadoc output hasn’t changed much in the past 20 years, so in some sense, it’s predictable and familiar. On the other hand, the output is dated and lacks some critical features, like search, or the ability to add more pages. In this topic, we’ll explore how the Javadoc is organized.
Open the index.html file in the Javadoc folder you generated in Activity: Generate a Javadoc from a sample project.
The class summary page shows a short version of each of the classes. The description you write for each class (up to the period) appears here. It’s kind of like a quick reference guide for the API.
You click a class name (in this case,
Dynamite) to dive into the details.
When you view a class page, you’re presented with a summary of the fields, constructors, and methods for the class. Again, this is just an overview. When you scroll down, you can see the full details about each of these elements.
If you click Package at the top, you can also browse the classes by package. Or you can go to the classes by clicking the class name in the left column. You can also browse everything by clicking the Index link.
For more information about how the Javadoc is organized, click the Help button in the Javadoc top navigation bar.
130/146 pages complete. Only 16 more pages to go.
Want to buy me lunch? Click the Donate button below to donate any amount through Paypal.