Package level JavaDoc
I have wondered for a while if there was an easy way to create package level JavaDoc without having to set up the appropriate HTML file. Well, I discovered a way, courtesy of Florent Guillaume:
Original post: http://lists.nuxeo.com/pipermail/ecm/2006-November/000268.html
The basic idea is that you create a java file in your package without a class definition. This file must be name 'package-info.java' and contain the correct package statement.
This is a real easy way, I tend to use the 'Generate JavaDoc' option in NetBeans IDE and it picks up the file. This is only usable from Java 5+.
Original post: http://lists.nuxeo.com/pipermail/ecm/2006-November/000268.html
The basic idea is that you create a java file in your package without a class definition. This file must be name 'package-info.java' and contain the correct package statement.
This is a real easy way, I tend to use the 'Generate JavaDoc' option in NetBeans IDE and it picks up the file. This is only usable from Java 5+.
0 Comments:
Post a Comment
<< Home