Where to Put JavaDoc for Package

Thread view:

E11 - 14 Nov 2005 13:20 GMT

Hi all,

By convention, where should we place the JavaDoc comments of the
package. I remember reading it somewhere before, but can't remember
exactly. If i recall correctly, we should create a new compilation unit
(*something*.java) which contains nothing (no class or interface)
except for the JavaDoc comments for the package.

But what's this *something.java*?

TIA and Regards,
Edwin

Reply to this Message

Daniel Dyer - 14 Nov 2005 13:22 GMT

> Hi all,
>
[quoted text clipped - 5 lines]
>
> But what's this *something.java*?

package-info.java

Like this:

/**
* This is my package.
*/
package com.mydomain.mypackage;

Dan.

Signature

Daniel Dyer
http://www.dandyer.co.uk

Reply to this Message

E11 - 14 Nov 2005 13:24 GMT

> package-info.java
>
[quoted text clipped - 4 lines]
> */
> package com.mydomain.mypackage;

Thanks! :-) And BTW, i thing HSQL is what i need too :)

Regards,
Edwin

Reply to this Message

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 ...