Как прикрепить javadoc или источники к jars в папке libs?

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

Non modifiable android dependencies classpath

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

12 ответов


лучший способ ответить на ваш вопрос-обобщить ответы Ксавьер, plastiv, VinceFR и Кристофер.

пошаговую инструкцию

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

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


пример

в примере используется библиотека 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.сосуд.свойства

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


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

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


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

JavaDoc view in Eclipse

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

Eclipse test project screenshot


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

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

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

     doc=docs
    
  3. добавьте папки javadocs в .

вы должны придумать следующую структуру папок:

├── 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, как упоминалось выше! Вот скриншот рабочего примера проекта, ссылающегося на GoogleAdMobAds Android библиотека.

GoogleAdMobAds Android library Eclipse project


в windows вы должны избежать обратной косой черты для ссылок на пути doc и src в файле свойств. Например, для android-поддержка-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". Вместо этого я создал папку "библиотеки" и использовал ее.

вы можете сделать следующее, И это всегда будет работать - даже если ADT должен изменить, как он изменяет, как он имеет дело с папкой "libs"в будущем:

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

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

enter image description here

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

enter image description here

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

enter image description here


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

проверить это комментарий в вопросах android.


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

вот как я это исправил:

  1. предварительное условие: обе библиотеки перечислены в разделе "библиотеки ссылок".

  2. щелкните правой кнопкой мыши на commons-io-2.4.jar и выберите Свойства. Появится следующее окно:

enter image description here

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

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

enter image description here

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


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

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

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


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

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

doc=d:\Android\javadoc\libGoogleAnalyticsServices

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

несоблюдение любого из этих шагов (не распаковка javadoc, ссылка на файл вместо папки и т. д.), похоже, нарушает его.


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

запись classpath перед:

<classpathentry kind="lib" path="[PATH_TO_MY_JAR]"/>

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

<classpathentry kind="lib" path="[PATH_TO_MY_JAR]" sourcepath="[PATH_TO_MY_SOURCE_JAR]"/>

надеюсь, что это помогает


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

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

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


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

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

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

Я надеюсь, что это поможет дать простой ответ на то, что я считаю очень простой задачей.


мой solucion:

загрузите плагин eclipse под названием: "Java Source Attacher Feature".

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

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

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

наслаждайтесь