CODEWITHSUNDEEP
javaeclipsejavadoc
Jonno
Jonno

Reputation: 1552

Generating Javadoc

An assignment I'm working on asks for :

Reasonable inline code documentation, providing Javadoc generated documentation, with method descriptions, parameter and return value descriptions.

Isn't that just /**? Or would it the eclipse generated version?

Upvotes: 1

Views: 1059

Answers (2)

Perception
Perception

Reputation: 80603

They are just asking for the code to be properly commented, in a way such that they can later extract the documentation via the javadoc tool. You should follow all the Javadoc best practices, and of course if you want extra credit, run the documentation phase of your build to actually generate the docs. I'm sure they will love that.

Upvotes: 4

Michael Borgwardt
Michael Borgwardt

Reputation: 346260

"Javadoc generated documentation" would be the HTML documentation generated from the /** comments in the code. I don't know whether eclipse has a function for that, but it is generally done with the javadoc command line tool that comes with the JDK.

Upvotes: 0

Related Questions