Как создать JavaDoc с помощью Android Studio без R и BuildConfig?

Я хочу сгенерировать JavaDoc для моей библиотеки, исключая R и BuildConfig. Функциональность Generate JavaDoc... из меню Tools не имеет возможности исключать файлы.

Как создать JavaDoc с помощью Android Studio без R и и BuildConfig?

Ответы

Ответ 1

Ответ RocketSpock почти есть, но не совсем (на момент написания). Я еще не могу прокомментировать, поэтому я опишу процесс, который я использовал для исключения R.java и BuildConfig.java из моей библиотеки Android Javadoc в Android Studio 1.2.2. Там в основном дополнительный диалог, который пригодится:

  • Откройте пункт меню Tools --> Javadoc.

  • Выберите Custom scope. Нет необходимости выбирать что-либо из   в раскрывающемся меню.

  • Нажмите значок ..., чтобы открыть диалоговое окно Scopes.
  • Добавьте новую настраиваемую область с зеленым значком +. Дайте ему   описательное имя, если хотите.
  • В Production Classes (не Library Classes, так как это   импорт) перейдите к модулю (модулям), которые вы хотите создать Javadoc,   и выберите любые отдельные файлы Java, которые вы хотите включить. В вашей   случае, вы, вероятно, захотите выбрать весь модуль, но   вручную исключить R.java и BuildConfig.java. По завершении нажмите OK, чтобы выйти из диалогового окна Scopes.
  • В диалоговом окне Specify Generate JavaDoc scope, если ваша новая область не выбрано в раскрывающемся меню Custom scope, выберите его сейчас, как а также любые другие дополнительные параметры, включая выходной каталог.
  • Наконец, нажмите OK, чтобы сгенерировать ваш Javadoc.

Ответ 2

Принятый ответ довольно сложный, и у меня есть лучший.

  • Откройте пункт меню Инструменты → Javadoc.
  • Выберите пользовательскую область. Затем выберите Project Files
  • Нажмите OK.

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

После этого вы увидите, что файлы R и BuildConfig исключены.

Ответ 3

Если вы хотите исключить сгенерированные файлы (R, BuildConfig и т.д.), вы можете указать настраиваемую область для генерации JavaDoc. Для правильной работы вам необходимо:

  • В представлении "Проект" слева выберите корневой исходный каталог для создания документов для (например, "com" ​​или "org" ).
  • Откройте диалоговое окно генерации JavaDoc (Tools → Generate JavaDoc...)
  • Выберите "Пользовательская область" (это пятый переключатель в моей версии) и выберите ваш модуль (например, "Библиотека модуля" )
  • Выберите другие свойства, такие как каталог вывода, видимость метода и т.д. и нажмите "ОК"

Что это. Ваши JavaDocs должны быть сгенерированы без включенных файлов R или BuildConfig.