2011-12-20 21 views
17

Jak wygenerować niestandardowy pakiet javadoc dla Androida 1.4?Jak zainstalować pakiet zgodności javadoc dla Androida?

Dokumenty referencyjne są dostępne online (example), ale czy jest jakieś miejsce, w którym można uzyskać plik zip z javadoc dostępnym w trybie offline?

Przypuszczam, że używanie javadoc byłoby całkiem proste, tylko kwestia ustawienia lokalizacji javadoc dla słoika zgodności.

Odpowiedz

28

Możesz samodzielnie generować javadoc offline z kodu źródłowego. Wystarczy przejść do android katalogu sdk następnie wykonaj następujące czynności

cd <path_to_android_sdk>/extras/android/compatibility/v4/ 
mkdir docs 

dla systemu Windows:

javadoc -d docs -sourcepath src\java -subpackages android.support.v4 

dla Linux/Mac:

javadoc -d docs -sourcepath src/java -subpackages android.support.v4 

To wygeneruje Javadocs dla Ciebie lokalnie w docs Katalog, który właśnie utworzyłeś.

Następnie w projekcie Android w Zaćmienie przejdź do właściwości projektu, w którym dodano swoją android-support-v4.jar, edytuj właściwości i dodaj ścieżkę do właśnie utworzonych javadocs.

To powinno zadziałać!

ADT 17+ kwestie:

Jak niektórzy z was zauważył. Pojawiły się problemy z uzyskaniem Eclipse, aby zobaczyć dołączone javadoc dla ADT 17+. Jest to znany problem i został zgłoszony błąd. Nie jest to związane ze sposobem generowania javadoc (jak opisałem powyżej), raczej jest to problem z integracją ADT 17+ z Eclipse. Ktoś opisał obejścia i można było śledzić tutaj:

http://code.google.com/p/android/issues/detail?id=28801

+0

jego "src/Java na komputerze Mac. w00p w00p ty – Blundell

+0

** UWAGA: ** od czasu ADT 17 to rozwiązanie już nie działa. [Źródło] (http://code.google.com/p/android/issues/detail?id=28801) –

+0

Nadal możesz wygenerować grzywnę javadoc, używając tego, co napisałem powyżej (co było celem pytania). Jeśli są problemy z Eclipse i ADT teraz pozwalając, aby zobaczyć go w IDE, to kolejny problem, który musi zostać rozwiązany. Dzięki za wskazanie! dobrze wiedzieć – wnafee

2

Odpowiedź przez @wnafee jest na miejscu, ale jeśli używasz Linuksa nie zapomnij użyć ukośnika w tym miejscu jak src/java.

12

problemu: Jeżeli android-support-v4.jar w folderze /libs (jak wymagają ADT 17+) Javadoc jest niedostępny.


Edit: Mam workarounded problem poprzez powiązanie wersji offline android javadoc do android-Support-v4.jar. O ile mi wiadomo, nadal nie można połączyć wersji online (http://developer.android.com/reference). Kroki:

  1. Pobierz dokumentację dla Androida SDK z Menedżera SDK. Możesz go znaleźć w najnowszej wersji Androida (4.1)
  2. link folder javadoc do folderu Twojego projektu, w systemie Windows otwórz konsolę i wpisz: MKLINK /J {PROJECT_PATH}\android_docs {SDK_PATH}\docs\reference
  3. utworzyć plik libs/android-support-v4.jar.properties z tej treści:

    src=android-support-v4.jar 
    doc=../android_docs 
    
  4. zamknąć projekt i ponownie go. W razie potrzeby wyczyść.

  5. Jawadok jest połączony. Sprawdź to, przechodząc do dowolnej klasy biblioteki Pomoc, jak android.support.v4.app.FragmentActivity

Dzięki tej odpowiedzi https://stackoverflow.com/a/11579339/933261

+0

Nadal możesz wygenerować javadoc offline, aby wyświetlić go w przeglądarce lub ręcznie. Opisujesz problem z dołączeniem go do IDE, aby ułatwić sobie kodowanie. – wnafee

+0

To jest naprawione/błędne: http://stackoverflow.com/questions/9873152/how-to-attach-javadoc-lub-sources-to-jars-in-libs-folder (dla mnie musiałem także ponownie uruchomić zaćmienie po, ORAZ zachowaj dokumentację na tym samym dysku) – pjco

+0

Up-vote, za pomocne edytowanie – pjco

2

jeśli jesteś na Windows i utknąć na wieki, jak mnie zrobić na pewno uciekniesz od swoich backsmashes w pliku właściwości, lub rzeczy będą po cichu zawieść. (Który sprawia, że ​​nieme ładowarki upadających tak ...)

To jest mój plik właściwości:

src=android-support-v4.jar 
doc=doc\\android-support-v4_doc 

i mój reż wygląda następująco:

android-support-v4.docs.zip 
android-support-v4.jar 
android-support-v4.jar.properties 
doc 

ścisłej projektu i otwarty, a to wszystko działa dla mnie.

0

Przeszedłem przez wszystkie te rozwiązania i żaden z nich nie zadziałał. Oto co udało się zmusić go do pracy:

  1. przejdź do następującego folderu: D: \\ Android-SDK \ android-sdk-windows \ Extras \ android \ Support \ v4

  2. uruchom polecenie: javadoc -d DOCS -sourcepath src \ java -subpackages android.support.v4

  3. w katalogu libs Twojego projektu, utwórz plik o nazwie android-support-v4.jar.properties

  4. W pliku właściwości dodaj następujące linie (zmień ścieżkę, aby pasowały do ​​Twojej):

    doc = D: \ Program Files \ Android-SDK \ android-sdk-windows \ dodatki \ android \ wsparcie \ v4 \ dokumenty src = D: \ Program Files \ Android SDK \ android-sdk-windows \ Extras \ android \ Support \ v4 \ src

  5. W Eclipse, przywołać okno dialogowe właściwości do produkcji, a następnie przejdź do produkcji Java Ścieżka i wybierz kartę Biblioteki.

  6. Rozwiń bibliotekę pomocniczą. W moim przypadku ścieżka to: D: \ Program Files \ Android-SDK \ android-sdk-windows \ dodatki \ android \ wsparcie \ v4

  7. Wybierz lokalizację Javadoc. Kliknij przycisk Edytuj, a następnie wybierz ścieżkę do dokumentów. W moim przypadku było to: plik:/D:/Program Files/Android-SDK/android-sdk-windows/dodatki/android/support/v4/docs/

  8. Zamknij wszystko, w tym Eclipse i uruchom ponownie. Powinieneś teraz móc przeglądać dokumenty w swoim kodzie.

Powiązane problemy