Missing JavaDoc
What is Javadoc?
Javadoc comment explains:
- what the class does, its author, and version.
- what the method does, its parameter, return value, and thrown exception.
Many times, instead of our source code, we share our JAR with the other team members and once they import our JAR into their project and start using it, they either:
- Don’t see any Javadoc comments for the provided methods and they see this message on hover over- “Note: The Javadoc for this element could neither be found in the attached source nor the attached Javadoc.”
- OR, they see partial comments as they do see the method params numbers but not the type, etc.
How to Fix this error?
1) Make sure that you have JavaDoc in place. To generate Java Doc in Eclipse: Select the “Generate JavaDoc” option from the Project menu
Specify the location for the JavaDoc file on your system
Select the project and then the packages/class for which you want to create the JavaDoc file.
Then click Next and then click Finish, it may take a while for Eclipse to execute the JavaDoc and finally, we’ll end up with nice documentation with a folder named “doc”.
2) Now attach this “doc” folder to apt. JAR:
Go to Project > Properties > Java Build Path > Libraries and Choose .jar file which has missing Javadoc>(You should see Javadoc location: (None)) Click Edit and Provide Javadoc location file and press OK.
Please do comment if you have any better way handy.
