Как исключить устаревшие общедоступные методы из Javadoc?

Я хотел бы создать Javadoc для моих классов. Команда "Создать Javadoc" дает мне возможность создать Javadoc для членов с видимостью Private/Package/Protected/Public. Но есть некоторые публичные методы, которые я не хочу включать в Javadoc. Как я могу указать для этого генератора Javadoc, какие именно элементы / методы должны быть включены, а какие нет?

(Я использую eclipse 3.4.2)

Изменить: Некоторые из вас спросили, почему я хочу это сделать. Причина в том, что у меня есть некоторые методы, которые я не хочу существовать, но мне все еще нужны их для обратной совместимости. Я пометил их как @deprecated, чтобы люди, которые пытаются их использовать, получали предупреждение. Но я не хочу, чтобы они вообще появлялись в Javadoc. Есть ли способ исключить их из javadoc, если они помечены как @deprecated?

4 ответа

Решение

Итак, почему javadoc -nodeprecated не делать трюк?

Вы должны написать свой собственный доклет.

Как пишет Software Monkey, вам, вероятно, придется написать свой собственный Doclet. Есть пример, который делает почти то, что вы хотели, ExcludeDoclet

Итак, у вас есть некоторые методы, которые по какой-то причине должны быть общедоступными, но есть ли у пользователей класса что-то такое, с чем не следует связываться?

Вы можете поместить этот вид JavaDoc для этих "скрытых" открытых методов:

 /**
  * !!! THIS METHOD IS NOT PART OF PUBLIC INTERFACE !!!
  * !!! DO NOT USE !!!
  */
 public void somethingThatShouldNotBeUsedByOutsiders()

Я бросил быстрый взгляд и, кажется, нет никакого способа сделать исключения уровня метода, по крайней мере, с помощью стандартных инструментов JavaDoc.

Другие вопросы по тегам