Search code examples
javajavadoc

Javadoc: link to package-info

I'm using package-info.java files in my javadoc. I'm trying to link from classes contained in a package to the package-info of the very same package. I have tried several options inspired by this Oracle document.

For example, the package is:

com.zombo.apps.api.stream

I'm inside com.orcsoftware.apps.api.stream.someClass and am writing

@see com.zombo.apps.api.stream.package-info

The link doesn't get rendered in the javadoc. How can I link to the package-info?

Solution

  • If you remove the .package-info it should work nicely:

    @see com.zombo.apps.api.stream