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 Companion static methods with parameters do not work when generating JavaDoc #205

Closed
erikhakansson opened this issue Aug 19, 2017 · 0 comments
Assignees
Milestone

Comments

@erikhakansson
Copy link

erikhakansson commented Aug 19, 2017

/**
 * Linking to [test]
 */
class TestClass {
  
  companion object {
    
    @JvmStatic fun test(arg: String) {}
  }
}

The above code will cause a lot of warnings of the type
Can't find node by signature testpackage.TestClass.Companion$test((kotlin.String)).

Without parameters it works, however the link is to the TestClass.Companion.test method, which while technically correct is rather ugly as the TestClass.test method is available to Java callers.

Further, on documentation on a method itself, it can't link to its own parameters, possibly for the same reason.

@semoro semoro added this to the 0.9.16 milestone Nov 4, 2017
@semoro semoro self-assigned this Nov 4, 2017
@semoro semoro closed this as completed in 694d51d Feb 22, 2018
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

2 participants