Как я могу задокументировать или исключить сгенерированный класс BuildConfig в моей документации?

Судя по всему, начиная с Android SDK 17, сборки генерируют автоматический класс BuildConfig и добавляют его в мой package. http://android-developers.blogspot.com/2012/03/updated-sdk-tools-and-adt-revision-17.html говорит:

Добавлена ​​функция, позволяющая запускать некоторый код только в режиме отладки. Сборки теперь генерируют класс BuildConfig, содержащий константу DEBUG, которая автоматически устанавливается в соответствии с вашим типом сборки. Вы можете проверить константу (BuildConfig.DEBUG) в своем коде, чтобы запускать функции только для отладки, такие как вывод журналов отладки.

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

Я использую Eclipse Indigo в Windows и стандартный Doclet.


android java eclipse javadoc buildconfig
person Michael Levy    schedule 16.10.2012    source источник
comment
Почему вам нужно удалить его?   -  person Raghav Sood    schedule 16.10.2012
comment
Я могу оставить его, но, поскольку я не могу добавлять комментарии javadoc к сгенерированному файлу, моя документация выглядит глупо. У меня есть один класс в моем пакете без описания, и конструктор и поле этого класса также не имеют комментариев. Я хотел бы, чтобы выходные данные Javadoc всегда были в состоянии готовности клиента.   -  person Michael Levy    schedule 16.10.2012
comment
Есть ли простой способ исключить этот класс из моей документации по пакету? -- Я не знаю, как вы генерируете документы, но класс Ant javadoc, похоже, обладает достаточной гибкостью для этого.   -  person CommonsWare    schedule 16.10.2012
comment
Сегодня я просто использую Eclipse и стандартный Javadoc Doclet, который идет вместе с ним.   -  person Michael Levy    schedule 16.10.2012
comment
Чтобы удалить его, просто снимите флажок с папки project/gen в мастере экспорта javadoc.   -  person yorkw    schedule 17.10.2012
comment
@yorkw - пожалуйста, опубликуйте это блестяще простое предложение в качестве ответа, чтобы я мог его принять.   -  person Michael Levy    schedule 17.10.2012

Ответы (1)


arrow_upward
1
arrow_downward

Чтобы удалить BuildConfig.java, просто снимите флажок с папки project/gen в мастере экспорта javadoc. Обратите внимание, что это также удаляет R.java из экспортированного javadoc:

введите здесь описание изображения

person yorkw    schedule 17.10.2012