Javadoc is a tool to generate API documentation from comments in the source code.
The comments must be compliant to a particular format and begin with /**
This is an example:
/**
* This method calculate the date of birth
* @param Username
* @return Date of birth
*/
Where @param is used before parameters and @return before return value descriptions.
Here is the procedure to generate the documentation in Eclipse:
1) Select project->Generate_javadocs
2) In the field "Javadoc command" insert the path of javadoc.exe, located in $JAVA_HOME$/bin
3) Select the project for which you want to create the documentation
4) Insert the destination folder
5) Follow the wizard and at the end the documentation will be in the destination folder that you have selected.
Copyright © 2013 Welcome to the website of Davis Fiore. All Rights Reserved.