Velocity Reviews - Computer Hardware Reviews

Velocity Reviews > Newsgroups > Programming > Java > Package HTML - Missing package documentation file

Reply
Thread Tools

Package HTML - Missing package documentation file

 
 
jochenhebbrecht@gmail.com
Guest
Posts: n/a
 
      08-23-2006
I'm finishing the code of my project with the checkstyle plugin of
Eclipse.

But I have 4 warnings for my packages:
=> Package HTML - Missing package documentation file

So I made a package.html in each package, but the warnings stays. How
do you have to documentate a package?

 
Reply With Quote
 
 
 
 
drobert_bfm drobert_bfm is offline
Junior Member
Join Date: Nov 2007
Posts: 1
 
      11-27-2007
If you're using Java5 +, you'll have to create a package-info.java file in the package, rather than a package.html one, for Checkstyle to do its job. The problem is with the text of the warning, not with the warning itself, though. The package-info.java file should contain nothing but the package declaration, properly javadoc-commented:

e.g.: /src/main/java/info/dummy/mypackage/package-info.java:

/**
* This is the core package for the application
* @since 1.0
*/
package info.dummy.mypackage;
 
Reply With Quote
 
 
 
Reply

Thread Tools

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
Re: Missing documentation for ElementTree? Gabriel Genellina Python 2 09-26-2007 04:10 PM
converting XSD documentation to HTML documentation kev.sully@gmail.com XML 1 09-16-2006 12:09 PM
Need suggesions for obtaining Missing documentation for Sony VGN-A250 NoteBook Computer purchased from Clackamas Oregon Best Buy Mary K. Gunn Computer Support 3 04-15-2005 04:14 PM
Python documentation: How about structured documentation? Looking for comments/suggestions Kenneth McDonald Python 2 05-06-2004 04:11 AM
Principles of documentation (was: Python Documentation Blows!) Cameron Laird Python 1 04-03-2004 06:54 PM



Advertisments