Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
student:java:javadoc [2020/09/02 09:21] – bernstdhstudent:java:javadoc [2025/08/21 16:23] (current) – bernstdh
Line 1: Line 1:
- 
- 
 ===== The Java Documentation Generator (javadoc) ===== ===== The Java Documentation Generator (javadoc) =====
  
Line 27: Line 25:
 Below is an annotated example of a method that contains ''%%javadoc%%''-formatted comments: Below is an annotated example of a method that contains ''%%javadoc%%''-formatted comments:
  
-{{javadocs.gif}}+{{javadocs.gif|An example of javadoc-formatted comments}}
  
 ==== Tags for Classes and Interfaces ==== ==== Tags for Classes and Interfaces ====
Line 82: Line 80:
 will create the HTML pages for the source files named ''%%Calculator.java%%'' and ''%%Controller.java%%''. will create the HTML pages for the source files named ''%%Calculator.java%%'' and ''%%Controller.java%%''.
  
-Many integrated development environments also have the capability of running the ''%%javadoc%%'' tool.+Many integrated development environments also have the capability of running the ''%%javadoc%%'' tool, including [[student:eclipse:help#creating_html_documentation|Eclipse]].
  
 Note that the ''%%javadoc%%'' tool generates a large number of     "supporting" files even if you only generate documentation for a     single class.  The file ''%%index.html%%'' is the "main" page. Note that the ''%%javadoc%%'' tool generates a large number of     "supporting" files even if you only generate documentation for a     single class.  The file ''%%index.html%%'' is the "main" page.
 +
 +
 +==== Troubleshooting ====
 +
 +If you're style-checker gives you a message like ''%%@param tag must be preceeded by a blank line%%'',  it probably means that there is extra whitespace on the line the line containing the ''%%@param%%'' tag. Delete anything (even if you can't see it) that is after the asterisk on the "blank" line.
 +