|
Home > Archive > Apache Directory Project > January 2007 > Using package-info.java
You are viewing an archived Text-only version of the thread.
To view this thread in it's original format and/or if you want to reply to
this thread please [click here]
| Author |
Using package-info.java
|
|
| Enrique Rodriguez 2007-01-27, 1:11 am |
| I'm working on doco for some of the modules, notably Kerberos. I
noticed that new with JDK 5.0 the "preferred" package comment file is
package-info.java. Any problem if I build out package comments with
that, since we're on 1.5 now?
{quote}
To create a package comment file, you have a choice of two files to
place your comments:
* package-info.java - Can contain a package declaration, package
annotations, package comments and Javadoc tags. This file is new in
JDK 5.0, and is preferred over package.html.
* package.html - Can contain only package comments and Javadoc tags,
no package annotations.
{quote}
Enrique
| |
| Trustin Lee 2007-01-27, 1:11 am |
| On 1/27/07, Enrique Rodriguez <enriquer9-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
>
> I'm working on doco for some of the modules, notably Kerberos. I
> noticed that new with JDK 5.0 the "preferred" package comment file is
> package-info.java. Any problem if I build out package comments with
> that, since we're on 1.5 now?
It sounds OK to me. We can also put some annotations on the package we
document if we use package-info.java.
Trustin
--
what we call human nature is actually human habit
--
http://gleamynode.net/
--
PGP key fingerprints:
* E167 E6AF E73A CBCE EE41 4A29 544D DE48 FE95 4E7E
* B693 628E 6047 4F8F CFA4 455E 1C62 A7DC 0255 ECA6
| |
| Enrique Rodriguez 2007-01-29, 7:11 pm |
| On 1/26/07, Trustin Lee <trustin-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> On 1/27/07, Enrique Rodriguez <enriquer9-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
>
> It sounds OK to me. We can also put some annotations on the package we
> document if we use package-info.java.
Cool, I'll go with package-info.java then.
Enrique
|
|
|
|
|