Home | Contact Us | FAQ | Search & Site Map | Link to Us
Sign In | Join | Other 45 Sites in Network
HomeAnnouncementsWhite Papers
Discussion GroupsFirst AidDatabasesJavaBeansGUIJava 3DVirtual MachineCORBASecurityToolsGeneral
Java DirectoryOpen Source ProjectsSample Book ChaptersUser GroupsWeb Resources
Related Topics
Databases.NETMore Topics ...

Java Forum / Tools / January 2006

Tip: Looking for answers? Try searching our database.

Netbeans 4.1: JavaDoc comment for package ?

Thread view: 
Lion-O - 25 Jan 2006 15:31 GMT
Hi there,

I'm almost done finishing up the first beta release of my (study) project and
so the time was come to dive more deeper into commenting. On a side note I have
to say considering Javadoc very appealing.

Alas, after having made the (obvious?) mistake of commenting my package and
discovering that this didn't work I read up on package-info.java and
package.html for commenting the whole package. Unfortunatly I couldn't make
Netbeans accept package-info.java so I resorted to the html file. While this
works excellent when it comes to Javadoc it also results in the html file being
included in my final jar distribution file. While this isn't a major problem I
don't consider it good practice...

So now I'm wondering if there is cleaner way in Netbeans to provide a Javadoc
comment for the entire package. Have I overlooked the obvious with
'package-info.java' or is there another option I could use ?

I was considering to see if I could make it ignore the package.html file when
building but I haven't come that far yet.

Thanks in advance for your comments.

Signature

Groetjes, Peter

.\\ PGP/GPG key: http://www.catslair.org/pubkey.asc

Lion-O - 26 Jan 2006 13:43 GMT
> I was considering to see if I could make it ignore the package.html file when
> building but I haven't come that far yet.

Well, that was simple but naturally I'm still wondering about the package-info
which is picked up as a illegal class. Anyway; project properties -> packaging
-> 'Exclude from JAR file'. In my case you enter '**/package.html' and all is
well (no '').

Signature

Groetjes, Peter

.\\ PGP/GPG key: http://www.catslair.org/pubkey.asc



Free Magazines

Get these publications absolutely FREE for up to 12 months. There are no hidden fees and no obligation. Simply choose a title, complete the application form and submit it. Read more ...

Oracle MagazineNetwork ComputingComputer WorldBio-IT WorldeWeekInformation WeekInfosecurity
 
Sign In
Join
My Latest Posts
My Monitored Threads
My Blog
My Photo Gallery
My Profile
My Homepage

Start New Thread
Enable EMail Alerts
Rate this Thread



©2008 Advenet LLC   Privacy Policy - Terms of Use
This website includes both content owned or controlled by Advenet as well as content owned or controlled by third parties.