CODEWITHSUNDEEP
javaandroidannotationsjavadoc
Nathua
Nathua

Reputation: 8826

What does @remove mean in javadoc in Android framework

I've been checking ContextWrapper.java in android sdk and noticed that there are some methods which are annotated in javadoc by @remove. I assume, it is an indicator to give lint warnings in IDE but that'd be great to know exactly what it is and why they needed such as thing in the first place instead of removing completely.

/** @removed */
@Override
public SharedPreferences getSharedPreferences(File file, int mode) {
    return mBase.getSharedPreferences(file, mode);
}

enter image description here

Upvotes: 2

Views: 812

Answers (1)

Trevor Dixon
Trevor Dixon

Reputation: 24362

Like @hide, it causes Doclava (a Javadoc doclet Android uses to generate SDK documentation and API signature text files) to omit the annotated member from generated documentation and, if the -api flag is passed, from the generated API signature text file. If the -removedApi flag is also used, members annotated @remove will be included in the removed.txt signature file.

Upvotes: 1

Related Questions