Search code examples
javajavadoc

Javadoc linking to a class in another package

I have two packages, Shapes and Fruits:

com.myproject.Shapes.
    Circle
    Square
    Triangle
com.myproject.Fruits.
    Apple
    Orange

I am writing the JavaDoc for Apple and need to provide an {@link} to Square.

I have tried all of the following, and none of them work:

{@link Square}
{@link com.myproject.Square}

I've been able to find documentation for linking to: (a) classes within the same package, or (b) externals URLs, but not classes in another package.

Any ideas what the correct syntax should be? Thanks!

Solution

  • The correct syntax variants are

    {@link [<package>.]<class>[#<method>]}
{@link #<method>}

    You were missing a complete package. The following example should be correct

    {@link com.myproject.Shapes.Square} 
                     ^^^^^^