Как исключить устаревшие общедоступные методы из Javadoc? - PullRequest
3 голосов
/ 18 января 2010

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

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

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

Ответы [ 4 ]

3 голосов
/ 18 января 2010

Итак, почему javadoc -nodeprecated не справляется?

1 голос
/ 18 января 2010

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

0 голосов
/ 18 января 2010

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

0 голосов
/ 18 января 2010

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

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

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

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

...