2016-10-19 88 views
0

我正在开发一个API,我需要给用户一些信息。悬停时显示信息功能/类

在我的具体情况下,我在下一个版本中标记了一个已弃用的类(我希望它可用,但让用户知道它将在不久的将来被删除)。

我想告诉用户这个函数在他/她悬停在它上面的时候不推荐使用,这是一个例子(这个例子显示了关于如何使用函数的信息,我有点不同,我只是想显示一些信息信息):

Example with DateFormat.format(Date date)

我的情况

我想显示消息As of release 0.4.0, replaced by WhateverClass悬停在上课的时候。

我已经在我的项目尝试这样:(这显然没有奏效,我就不会在这里,如果它确实)

/** 
* @deprecated As of release 0.4.0, replaced by {@see main.chart.FXPieChart} 
*/ 
@Deprecated 
public class PieChart extends JPanel { 
    //Whatever.... 
} 

我怎样才能实现呢?

(我希望我解释得很好,我的英语远非完美,请随时编辑,如果你看到任何拼写/语法错误)。

谢谢大家。

更新:

这是我看到在我的课:

Hovering over PieChart (My Class)

+0

shopuld工作,因为它是由javadoc支持....你是为该API生成罐子?包括那里的javadoc? –

+0

请张贴屏幕截图,显示您在案件中看到的是什么 – Ivan

+0

我刚刚更新了我在我的案例中看到的内容@Ivan – Tuzane

回答

0

我发现这个问题。这比我想象的要简单得多,也是我的错,而不是一个错误。

解决方案:

当编译.jar文件,并选择创建的JavaDoc,请确保您选择Export all output folders for checked projects选项。如果您没有具体说明,Eclipse将不会添加文档文件。