2016-10-19 1 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.... 
} 

Как я могу добиться этого?

(Я надеюсь, что все объясняю хорошо, мой английский далеко не идеален, пожалуйста, не стесняйтесь редактировать, если вы видите ошибки орфографии/грамматики).

Спасибо всем.

Update:

Это то, что я вижу в моем классе:

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 не добавит файлы документации, если вы специально не сообщите об этом.

Смежные вопросы