Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Links to Java static fields are not correctly translated. #88

Open
jroper opened this issue Aug 25, 2016 · 0 comments
Open

Links to Java static fields are not correctly translated. #88

jroper opened this issue Aug 25, 2016 · 0 comments

Comments

@jroper
Copy link
Member

jroper commented Aug 25, 2016

I'm not sure if this applies to a broader scope, eg to methods or non static fields, but if I have a Java class with a static field:

public class Foo {
  public static final int BAR = 10;
}

And then I reference it in some scaladocs:

/**
 * A reference to [[Foo.BAR]]
 */

genjavadoc will produce:

/**
 * A reference to {@link Foo.BAR}
 */

This is not the right way to reference fields, javadoc will subsequently fail. It should produce:

/**
 * A reference to {@link Foo#BAR}
 */

This can be worked around by using the following incorrect Scaladoc:

/**
 * A reference to [[Foo#BAR]]
 */
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant