plugin - install android eclipse oxygen




Como anexar o javadoc ou fontes para jars na pasta libs? (8)

Nova versão do plugin ADT r17 para o recurso adicionado do Eclipse para configurar automaticamente as dependências JAR. Quaisquer arquivos .jar na pasta / libs são adicionados à configuração de compilação agora. Infelizmente, o contêiner classpath do Android Dependencies não é modificável.

Como posso anexar o javadoc e fontes ao arquivo .jar (da pasta / libs) inserido automaticamente?


A melhor maneira de responder sua pergunta é resumir as respostas de code.google.com/p/android/issues/detail?id=27490#c21 , plastiv , VinceFR e Christopher .

Guia passo a passo

Para vincular as fontes e o javadoc a uma biblioteca .jar que é vinculada automaticamente pelo Eclipse, é necessário fazer o seguinte:

  1. Coloque o arquivo .jar da biblioteca na pasta libs e os arquivos .jar e doc .jar de origem associados em subpastas separadas, como libs / src e libs / docs . Você pode usar um nome diferente de src e docs se quiser, mas é importante que os arquivos .jar não estejam diretamente na pasta libs .
  2. Crie um arquivo .properties na pasta libs com o nome exato da biblioteca real .jar (veja o exemplo). Certifique-se de manter a parte .jar .
  3. Especifique os caminhos relativos para as fontes e javadoc .jar no arquivo .properties .
  4. Feche e reabra o projeto Eclipse! Opcionalmente, atualize o projeto pressionando F5 .
  5. Selecione um objeto da biblioteca vinculada no código-fonte.
  6. Abra a visualização Javadoc no Eclipse para verificar a documentação (veja a captura de tela).
  7. Abra a declaração do código-fonte (atalho padrão: F3 ) do objeto selecionado.


Exemplo

O exemplo usa a biblioteca Gson .

Estrutura de diretórios da pasta 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

Conteúdo do gson-2.2.2.jar.properties

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


Informação adicional

É claro que você pode mover o javadoc e o sources .jar para outras pastas e especificar caminhos relativos. Isso é contigo. Colocar os jars source e javadoc diretamente na pasta lib é possível, mas não é recomendado , pois isso faz com que a documentação e o código-fonte sejam incluídos em seu aplicativo .


Captura de tela do painel Eclipse JavaDoc:

Captura de tela de um projeto do Eclipse usando o Gson com Android 4.2.2 .:

Referenciando javadocs descompactados

Caso você queira fazer referência a javadocs que não são fornecidos como um .jar compactado, mas simplesmente como arquivos e pastas conforme solicitado pelo desenvolvedor do Android nos comentários, faça o seguinte:

  1. Coloque a biblioteca .jar na pasta libs/
  2. Crie um arquivo yourlibraryname.jar.properties ( não esqueça o .jar ) com o seguinte conteúdo:

     doc=docs
  3. Adicione as pastas javadocs à pasta libs/ .

Você deve criar a seguinte estrutura de pastas:

├── 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

Não esqueça de fechar e reabrir o projeto Eclipse como mencionado acima! Aqui está uma captura de tela de um projeto de exemplo funcional que faz referência à biblioteca do GoogleAdMobAds para Android .


A referência da biblioteca ao commons-io-2.0.1.jar foi interrompida quando atualizei para o SDK Tools e para a revisão 17 do ADT.

Para resolver o problema, usei Project -> Properties -> Java Build Path e selecionei a guia Bibliotecas. Excluí qualquer referência ao commons-io-2.0.1.jar e, em seguida, usei Add Jar para adicionar novamente commons-io-2.0.1.jar ao projeto. Em seguida, clico na seta '>' ao lado do nome da biblioteca para expandir a referência da biblioteca e usei os botões de edição para definir o anexo Origem e o local do Javadoc.

Desculpe eu não posso postar uma imagem como eu não tenho bastante representante (por favor ...).


Eu tentei todos os itens acima e nenhum deles funcionou para mim. Eu descobri um método que sempre funcionará. Basicamente, o culpado é o modo como o ADT trata a pasta "libs", então eu parei de usar a pasta "libs". Em vez disso, criei uma pasta "libraries" e a usei.

Você pode fazer o seguinte e sempre funcionará - mesmo que o ADT mude como ele altera a pasta "libs" no futuro:

  1. Crie uma pasta "bibliotecas".
  2. Crie uma subpasta sob ela para cada biblioteca.
  3. Coloque todos os arquivos para cada biblioteca na pasta apropriada (java jar file, source jar file, javadoc jar file, etc).
  4. Adicione o arquivo jar java para cada projeto na guia "Bibliotecas" do Caminho de Construção Java clicando no botão Adicionar Jars ... para adicionar o jar da subpasta da biblioteca na pasta "libraries".
  5. Anexe a fonte / javadocs a cada projeto abrindo o projeto na aba "Bibliotecas", selecionando o item desejado, e clicando no botão Editar ... para adicionar a fonte / javadocs da sub-pasta da biblioteca nas "bibliotecas" pasta.
  6. Marque a caixa de seleção de cada projeto na guia "Solicitar e exportar" para o caminho de construção Java.
  7. Depois de verificar que todas as bibliotecas foram movidas, exclua a pasta "libs".

Seguindo o procedimento acima, seu projeto terá pastas semelhantes a esta:

Seu Java Build Path será parecido com isto:

Em Ordem e Exportar, as bibliotecas estão marcadas:


Minha solucion:

Faça o download de um plugin do eclipse chamado: "Java Attacher Feature".

Mais tarde, selecione um jar e anexe o código-fonte usando este plugin. Clique no arquivo jar para selecioná-lo, botão direito no mouse e selecione "anexar origem java".

Quando você tem o código-fonte, você tem automaticamente o javadoc.

Agora você pode usar F2 sobre as classes para visualizar o javadoc associado.

Apreciar


No windows você tem que escapar da barra invertida para referências aos caminhos doc e src no arquivo de propriedades. Exemplo, para android-support-v4.jar, o conteúdo do arquivo de propriedades é algo como:

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

Para qualquer jar determinado, se você quiser ver a ajuda do Javadoc na dica ao codificar, faça o seguinte: Clique com o botão direito do mouse em seu projeto> Propriedades> Caminho de Construção Java> Guia Bibliotecas. Clique na seta ao lado do seu jar para expandir.

O anexo de origem deve apontar para o local do jar real (provavelmente na sua pasta java).

Localização Javadoc : Você tem duas opções aqui: URL e arquivo. Se os seus javadocs para este jar estão na forma de uma pasta contendo um arquivo index.html no primeiro nível, escolha 'Javadoc URL' e aponte para essa pasta. Se os seus javadocs estiverem em um jar, escolha 'Javadoc no arquivo' e aponte para o jar. Não se esqueça de reiniciar sua área de trabalho / fechar e reabrir seu projeto para atualizar a dica de ferramenta com as informações do Javadoc.

Espero que isso ajude a dar uma resposta simples para o que eu acredito que seja uma tarefa muito simples.


Por enquanto, mova a biblioteca que você deseja que o Javadoc lib . Eles adicionam essa biblioteca ao Build Path e adicionam o Javadoc.

Verifique este comment nos problemas do Android.


Uma resposta vem de code.google.com/p/android/issues/detail?id=27490#c21

Na sua pasta libs, você deve ter:

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

E no seu foo.jar.properties , basta colocar doc=./doc/foo_doc

Talvez você precise atualizar seu projeto, limpá-lo, fechá-lo e reabri-lo.

Funciona para mim!







javadoc