Java Documentation Html Rendering Guide
Hello everyone, I recommend you to read my Java Documentation Preparation Guide, which is both my first medium article and the building block of the Java Documentation Html Render topic that we will talk about now. So let’s start 🚩
Documentation Processing Page
To be honest, I thought a lot about what to call it, and I found this to be the most accurate and appropriate. Because we don’t always read or process the documentation we create in our Java code. For this, we usually take advantage of the facilities provided by the IDE and render WEB PAGES where we can see this documentation together.
I have attached below what kind of page we are talking about.
How we can Generate ?
I will explain how to do it immediately with images
First, after writing our java document codes;
Click on the Tools Tab in our Intellij Idea IDE, then click on the Generate JavaDoc… tab.
Then I specify that I want the documents of my entire project on the page that opens. then I select my output directory settings, I press the OK button without touching the remaining default settings.
Immediately after that, I see that my HTML files and javascript files required for DOM are created in the output directory which I specified.
Let’s Recognize Created Web Pages
In the header section, we are greeted with Package, Class, Tree and index tabs.
Package : Lists the Classes in the package and related packages in the same directory
Class : It is the tab that gives general information about the docs and class
Tree : Shows the Hierarchy order in the package
Index: Organizes alphabetically
an example class
Let’s see how the getDummyDatas method we wrote in our Java Code looks like on the Web Page.
Rest of the Class…
My greatest wish is that you experience the rest of the parts yourself by preparing the documentation of your own project. at this point, I tried to guide you as much as I could.
Good work, everyone.
