@remove在Android框架中的javadoc中意味着什么

Question

我一直在检查android sdk中的ContextWrapper.java并注意到有一些方法在@remove的javadoc中注释。我假设，这是一个在IDE中给出lint警告的指示器，但很高兴知道它到底是什么以及它们为什么需要这样的东西而不是完全删除。

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

Answer 1

与@hide一样，它会导致Doclava（Android用来生成SDK文档和API签名文本文件的Javadoc doclet）从生成的文档中省略带注释的成员，如果是-api从生成的API签名文本文件传递flag。如果还使用了-removedApi标记，则注释@remove的成员将包含在removed.txt签名文件中。