Kotlin: How can I reference a method in kDoc using @see?

Question

I used to reference methods in Java Doc like this:

/** * @see com.myapp.view.fragment.PlaybackControlFragment#onPlaybackStateChanged */

I don't know how to reference same method in kotlin?

The part com.myapp.view.fragment.PlaybackControlFragment is linked however method name is not clickable and link.

What is the right syntax?

Bartek Lipinski · Accepted Answer · 2018-10-23 12:02:58Z

16

Just change # to . and it will work correctly.

/** * @see com.myapp.view.fragment.PlaybackControlFragment.onPlaybackStateChanged */

answered Oct 23, 2018 at 12:02

31.5k10 gold badges103 silver badges138 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

But what about method overloading?

What do you mean @RomanMitasov? You want to refer to a parent function from the child class?

Overloading it's when there are several methods with the same name and within the same scope but with different parameters

Thanks for explaining what overloading means 🙂 I'm asking this question because I don't understand how your question relates to my answer?

How to refer overloaded method in @see?

|