Documentation Tool - rimi303/SoftwareEngineeringProject GitHub Wiki

Documentation Tool: Javadoc

Installation process:

Javadoc tool- included in the JavaTM development kits. You can obtain the Javadoc tool by downloading the relevant JDK or SDK. Make sure JDK/bin folder add to the PATH of an environment variable. Javadoc 5 is included in JDK 5

Using Javadoc:

Follow the steps showed in the YouTube video below to have an idea about how to generate documentation from java source codes using the “Javadoc” documentation tool (link given).

Link: How to write doc comments for the Javadoc Tool

Link: Generate documentation in IntelliJ IDEA using Javadoc(video)

Source Code Documentation Example:

Source Code:

Pic1

HTML Documentation:

Pic2