2016-10-19 82 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將不會添加文檔文件。