Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision |
| student:java:javadoc [2018/08/10 13:23] – created bernstdh | student:java:javadoc [2024/09/11 14:42] (current) – bernstdh |
|---|
| |
| |
| ===== The Java Documentation Generator (javadoc) ===== | ===== The Java Documentation Generator (javadoc) ===== |
| 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. |
| | |
| |
| |
| The ''%%javadoc%%'' tool is very powerful and has a number of capabilities that are not discussed here. For more information, see: | The ''%%javadoc%%'' tool is very powerful and has a number of capabilities that are not discussed here. For more information, see: |
| |
| * [[ http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html | Using the ''%%javadoc%%'' Tool ]] | * [[ http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html | Using the javadoc Tool ]] |
| * [[ http://www.oracle.com/technetwork/articles/java/index-137868.html | Writing Comments for the ''%%javadoc%%'' Tool ]] | * [[ http://www.oracle.com/technetwork/articles/java/index-137868.html | Writing Comments for the javadoc Tool ]] |
