2013-08-15 3 views
0

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

В настоящее время я выполняю это, создавая два JavaDocs с использованием Eclipse, один открытый и один защищенный, а затем заменяя файл в открытом JavaDoc на один из защищенного JavaDoc.

Есть ли более простой способ выполнить эту задачу? Я не могу найти параметр в Eclipse, который позволит мне выбрать отдельный файл для дополнительной документации.

+1

Честно говоря, я не знаю, почему вы чувствуете, что это необходимо. Если вы разрабатываете API для использования внешними клиентами, то как публичные классы, так и члены класса AS WELL AS защищенные члены и расширенные ими абстрактные методы являются, безусловно, абсолютно частью вашего экспортированного API, и они должны быть задокументированы в тот же JavaDoc. Я не думаю, что было бы правильно, если бы пользователи вашей экспортированной рыбы API могли получить информацию в разных местах. – scottb

ответ

0

Вы можете достичь этого с помощью муравья. Я думаю, что затмение не может сделать это сам.

Ant javadoc

Пример:

<javadoc 
     destdir="docs/api" 
     author="true" 
     version="true" 
     use="true" 
     windowtitle="Test API"> 
</javadoc> 
Смежные вопросы