Warning: Dangling Javadoc comment

android android-studio javadoc android-studio-2.3
Dhunju_likes_to_Learn picture Dhunju_likes_to_Learn · Apr 12, 2017 · Viewed 21.7k times · Source

Since I updated my Android Studio (2.3.1) and build tools (2.3.1), I'm getting warning,

Warning: Dangling Javadoc comment

for comments like,

/** set name with format, {@Link FORMAT_NAME} **/
setNameText(getFormattedName(FORMAT_NAME));

As you can see, I use javadoc style comment for linking and others. I'm wondering if there are other comment alternatives that have linking feature.

Thanks.

Answer

gjigandi picture gjigandi · Apr 22, 2017

It looks like you are using a Javadoc comment when you call the method setNameText. Javadoc comments are to be inserted above a class declaration, a method declaration, or a field declaration.

If you simply want a comment when calling the method, use the one-line comment: // get formatted name based on {@link FORMAT_NAME}.

Related questions

Change Author template in Android Studio

I want to change the automatic author that appears when I create a file in AndroidStudio. /** * Created by a556520 on 16/01/14. */ public class POI { The author takes 'a556520' but I want that appears my name, and not the number of …

Read More
How to create JavaDoc using Android Studio without R and BuildConfig?

I want to generate the JavaDoc for my library excluding R and BuildConfig. The Generate JavaDoc... functionality from the Tools menu does not have the option to exclude files. How to create JavaDoc using Android Studio without R and and …

Read More
Android Studio: Javadoc is empty on hover

I have moved from Eclipse to Android Studio recently, and am liking it. However, I miss the Javadoc on hover feature from Eclipse. I followed the instructions here to add the functionality, however, my hovers contain no Javadoc. If I …

Read More