Как подключить javadoc или источники к банкам в папке libs?

Новая версия плагина ADT r17 для функции добавления Eclipse для автоматической настройки зависимостей JAR. Любые файлы .jar в папке / libs теперь добавляются в конфигурацию сборки. К сожалению, контейнер для classов Android Dependencies не подлежит изменению.

Не изменяемые андроидные зависимости classpath

Как я могу присоединить javadoc и источники к автоматически вставленному .jar (из папки / libs)?

Лучший способ ответить на ваш вопрос – суммировать ответы от Xavier , plastiv , VinceFR и Christopher .

Пошаговое руководство

Чтобы связать источники и javadoc с библиотекой .jar, которая автоматически связана Eclipse, вам необходимо сделать следующее:

  1. Поместите файл .jar библиотеки в папку libs и связанные файлы .jar и doc .jar в отдельные подпапки, такие как libs / src и libs / docs . Вы можете использовать имя, отличное от src и docs, если хотите, но важно, чтобы файлы .jar не были непосредственно в папке libs .
  2. Создайте файл .properties в папке libs с точным именем фактической библиотеки .jar (см. Пример). Убедитесь, что вы сохранили часть .jar .
  3. Укажите относительные пути к источникам и javadoc .jar в файле .properties .
  4. Закройте и снова откройте проект Eclipse! При желании, обновите проект, нажав F5 .
  5. Выберите объект связанной библиотеки в исходном коде.
  6. Откройте представление Javadoc в Eclipse, чтобы проверить документацию (см. Снимок экрана).
  7. Откройте декларацию исходного кода (по умолчанию ярлык: F3 ) выбранного объекта.

пример

В этом примере используется библиотека Gson .

Структура каталогов папки libs:

 libs ├── docs │  └── gson-2.2.2-javadoc.jar ├── gson-2.2.2.jar ├── gson-2.2.2.jar.properties └── src └── gson-2.2.2-sources.jar 

Содержание gson-2.2.2.jar.properties

 src=src/gson-2.2.2-sources.jar doc=docs/gson-2.2.2-javadoc.jar 

Дополнительная информация

Конечно, вы можете перемещать javadoc и источники .jar в другие папки и указывать относительные пути. Это зависит от вас. Размещение исходных и javadoc банок непосредственно в папке lib возможно, но не рекомендуется , поскольку это приводит к включению документации и исходного кода в ваше приложение .

Снимок экрана панели JavaDoc Eclipse:

Просмотр JavaDoc в Eclipse

Скриншот проекта Eclipse с использованием Gson с Android 4.2.2 .:

Скриншот проекта проекта Eclipse


Ссылка на распакованные javadocs

Если вы хотите ссылаться на javadocs, которые не представлены как упакованные .jar а просто как файлы и папки, заданные разработчиком Android в комментариях, выполните следующие действия:

  1. Поместите библиотеку .jar в папку libs/
  2. Создайте файл yourlibraryname.jar.properties ( не забудьте .jar ) со следующим содержимым:

      doc=docs 
  3. Добавьте папки javadocs в папку libs/ .

Вы должны создать следующую структуру папок:

 ├── docs │  ├── allclasses-frame.html │  ├── allclasses-noframe.html │  ├── com │  │  └── google │  │  └── ads │  │  ├── Ad.html │  │  │ .... │  │  └── package-tree.html │  │  ... │  └── stylesheet.css ├── GoogleAdMobAdsSdk-6.4.1.jar └── GoogleAdMobAdsSdk-6.4.1.jar.properties 

Не забудьте закрыть и снова открыть проект Eclipse, как указано выше! Вот скриншот рабочего примера проекта, связанного с библиотекой Android GoogleAdMobAds .

Библиотека GoogleAdMobAds для Android Eclipse

В windowsх вы должны избегать обратной косой черты для ссылок на пути doc и src в файле свойств. Например, для содержимого файла свойств для android-support-v4.jar есть что-то вроде:

 doc=C:\\Program Files (x86)\\Android\\android-sdk\\extras\\android\\support\\v4\\docs src=C:\\Program Files (x86)\\Android\\android-sdk\\extras\\android\\support\\v4\\src 

Ответ получен из http://code.google.com/p/android/issues/detail?id=27490#c21

В папке libs вы должны иметь:

 doc(folder) foo_doc(folder) index.html ... ... foo.jar foo.jar.properties 

И в вашем foo.jar.properties просто поставьте doc=./doc/foo_doc

Возможно, вам придется обновить свой проект, очистить его, закрыть его и снова открыть.

Меня устраивает!

Я пробовал все вышеперечисленное, и никто из них не работал на меня. Я понял метод, который всегда будет работать. В принципе, виновником является то, как ADT обрабатывает папку «libs», поэтому я ухожу из папки «libs». Вместо этого я создал папку «libraries» и использовал ее.

Вы можете сделать следующее, и он всегда будет работать – даже если ADT должен изменить, как он изменит, как он относится к папке «libs» в будущем:

  1. Создайте папку «libraries».
  2. Создайте подпапку под ней для каждой библиотеки.
  3. Поместите все файлы для каждой библиотеки в соответствующую папку (файл java jar, файл источника jar, файл javadoc jar и т. Д.).
  4. Добавьте файл java jar для каждого проекта на вкладке «Библиотеки» для пути сборки Java, нажав кнопку « Добавить банки ...» , чтобы добавить банку из подпапки библиотеки в папке «library».
  5. Прикрепите источник / javadocs к каждому проекту, открыв проект на вкладке «Библиотеки», выбрав нужный элемент и нажав кнопку « Изменить ...» , чтобы добавить источник / javadocs из подпапки библиотеки в «библиотеки», папка.
  6. Установите флажок для каждого проекта на вкладке «Заказ и экспорт» для пути сборки Java.
  7. После проверки того, что все библиотеки были перемещены, удалите папку «libs».

Следуя приведенной выше процедуре, ваш проект будет иметь папки, которые выглядят следующим образом:

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

Ваш путь построения Java будет выглядеть примерно так:

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

В порядке и экспорте библиотеки отмечены галочкой:

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

Пока переместите библиотеку, в которую вы хотите, чтобы Javadoc был в lib . Они добавят эту библиотеку в Build Path и добавят Javadoc.

Проверьте этот комментарий в проблемах с Android.

В ADT 22 я не смог получить доступ к Javadoc для обеих коммон-io-2.4.jar и android-support-v4.jar

Так я его исправил:

  1. Предварительное условие: обе библиотеки перечислены в разделе «Связанные библиотеки».

  2. Щелкните правой кнопкой мыши на commons-io-2.4.jar и выберите «Свойства». Появится это окно:

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

commons-io-2.4.jar в комплекте с commons-io-2.4-javadoc.jar, поэтому я указал Javadoc в архиве Внешний путь к файлу.

Я сделал то же самое для библиотеки поддержки: щелкните правой кнопкой мыши на android-support-v4.jar и выберите «Свойства». Появится этот экран:

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

На этот раз я указал путь к исходному каталогу.

Ссылка на библиотеку commons-io-2.0.1.jar была нарушена, когда я обновился до SDK Tools и версии 17 для ADT.

Чтобы решить проблему, я использовал Project -> Properties -> Java Build Path, и я выбрал вкладку Libraries. Я удалил любую ссылку на commons-io-2.0.1.jar, а затем использовал Add Jar для повторного добавления commons-io-2.0.1.jar в проект. Затем я нажимаю стрелку «>» рядом с именем библиотеки, чтобы развернуть ссылку на библиотеку, и я использовал кнопки редактирования, чтобы установить вложение «Источник» и местоположение Javadoc.

Извините, я не могу опубликовать изображение, так как мне не хватает репутации (пожалуйста …).

Кажется, это движущаяся цель, но после того, как собрал биты и куски из многих мест (включая ответы на этот самый вопрос, который помог, но не смог описать все необходимые детали, или, может быть, система немного изменилась за это время), это, похоже, решение, по крайней мере, на данный момент (28 августа 2013 г.).

  • Откройте папку для ваших javadocs где-то не внутри вашего проекта.
  • Поместите свои javadocs туда, распакованными, каждый в свою папку.
  • Внутри папки lib добавьте файл xxx.jar.properties для каждого lib, с которым вы хотите связать javadoc.
  • В этом файле свойств обратитесь к папке, в которую вы разархивировали соответствующий javadoc (в Windows, избегайте обратных косых черт):

doc=d:\\Android\\javadoc\\libGoogleAnalyticsServices

  • Закройте и снова запустите проект в Eclipse (обновление недостаточно). Теперь вы должны увидеть всплывающие подсказки при наведении курсора на соответствующие classы.

Если вы не заметите какие-либо из этих действий (не распаковывая javadoc, ссылаясь на файл вместо папки и т. Д.), Похоже, это сломает.

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

classpath:

  

После добавления пути к источнику

  

Надеюсь это поможет

просто обновите плагин ADT. Это сработало для меня!

  1. Запустите Eclipse, затем выберите «Справка»> «Установить новое программное обеспечение».
  2. Нажмите «Добавить» в верхнем правом углу.
  3. В появившемся диалоговом окне «Добавить repository» введите «ADT Plugin» для имени и следующего URL-адреса для местоположения: https://dl-ssl.google.com/android/eclipse/. Примечание. Сайт обновления для Android Developer Tools требует безопасное соединение. Убедитесь, что URL-адрес сайта обновления начинается с HTTPS.
  4. Нажмите «ОК». В диалоговом окне «Доступное программное обеспечение» установите флажок «Инструменты разработчика» и нажмите «Далее».
  5. В следующем окне вы увидите список инструментов для загрузки. Нажмите “Далее.
  6. Прочтите и примите лицензионные соглашения, затем нажмите «Готово».
  7. Если вы получите предупреждение о безопасности, указывающее, что подлинность или действительность программного обеспечения не может быть установлена, нажмите «ОК».
  8. По завершении установки перезапустите Eclipse

Надеюсь, это поможет!

Для любой конкретной банки, если вы хотите увидеть подсказку Javadoc во всплывающей подсказке во время кодирования, сделайте следующее: Щелкните правой кнопкой мыши свой проект> Свойства> Путь сборки Java> вкладка «Библиотеки». Нажмите стрелку рядом с банкой, чтобы развернуть ее.

Ссылка источника должна указывать на местоположение фактической банки (возможно, прямо в вашей папке java).

Местоположение Javadoc : у вас есть два варианта: URL и архив. Если ваши javadocs для этой банки представлены в виде папки, содержащей файл index.html на первом уровне, выберите «Javadoc URL» и укажите на эту папку. Если ваши javadocs находятся в банке, выберите «Javadoc в архиве» и укажите на банку. Не забудьте перезапустить рабочее пространство / закрыть и снова открыть проект, чтобы обновить всплывающую подсказку с помощью информации Javadoc.

Надеюсь, это поможет дать простой ответ на то, что, по моему мнению, должно быть очень простой задачей.

Мой соблазн:

Загрузите плагин eclipse под названием «Функция источника Java-источника».

Позже выберите банку и прикрепите исходный код с помощью этого плагина. Нажмите в файле jar, чтобы выбрать его, правой кнопкой мыши на мыши, а затем выберите «attach java source».

Когда у вас есть исходный код, вы автоматически используете javadoc.

Теперь вы можете использовать F2 над classами для просмотра asaviated javadoc.

наслаждаться

  • Javadoc: package.html или package-info.java
  • Кодовая документация для delphi, аналогичная javadoc или c # xml doc
  • Как ссылаться на метод в javadoc?
  • Давайте будем гением компьютера.