tonycituk / javadoc-example

javadoc example

Javadoc example

This was created using the java-17-openjdk.

Steps to reproduce

• Install a JDK

• Create a example class (MyClass.java) (it can be inside a package)

• Comment out the code with the javadoc syntax.

• Run javadoc

javadoc -d docs/ mypackage

• The doc should look like this.