Como gerar um PDF a partir de JavaDoc (incluindo resumo geral e pacotes)
escrevi uma extensa documentação JavaDoc sobre a minha aplicação, e adicionei muitas informações úteis em {[[0]} e package.html (incluindo links sobre o primeiro para ilustrações em doc-files/). O plugin Javadoc de Maven usa bem a ferramenta javadoc padrão para gerar o clássico Frameset JavaDoc, mas agora eu preciso gerar um PDF com toda a documentação.
AurigaDoclet gera PDFs muito bonitos, e eu fui capaz de fazer DocFlex funcionar também. No entanto, ambos ignoram meus arquivos {[[0]} e package.html (experimentado dentro e fora de Maven - o PDF será uma única coisa, já que eu prefiro ter o HTMLs a longo prazo).
4 answers
Baixe uma compilação livre do software (a versão oficial do site requer uma licença, mas é GPL-ed, para que você possa encontrar binários livres como Este , que é um instalador simples e funcional para o Windows);
Gerar os seus documentos HTML tradicionais da sua forma preferida (Ant, Maven, linha de comandos javadoc - a sua escolha);
O GUI é bom ,mas adicionar todos os arquivos manualmente pode ser complicado, então basta criar um.book file with Document Type set to "Web Page", add one of the HTML files from your generated javadoc's root folder (e.g., overview-summary.html, qualquer um vai fazer, é apenas para referência no Passo 5). No Página de saída seleccione o formato PDF e defina um nome para ele, e adicione outras opções ao conteúdo do seu coração (logotipos, cores, muitas coisas fixes aqui). Grava este projecto (diga,
myjavadocpdf.book) e fecha a interface gráficaGerar uma lista de todos os arquivos HTML em seu javadoc. Fi-lo com o comando de procura do Cygwin (Os meus dias de shell dos/cmd acabaram há muito), mas pode fazer tudo o que quiser, desde que obtenha uma lista de ficheiros. No meu caso, a
find . | grep html$ | sort -r > files.txtfez o truque; Para os usuários do Windows,dir /s/b *.html > files.txtdeve fazer o mesmo (mas tenha em mente que você pode ter que substituir\s por/s se eles aparecerem assim no próximo passo).Abre a porta .o ficheiro de livro gerado no Passo 3 do seu editor de texto puro favorito (como programador, deverá ter opiniões fortes sobre isso, por isso irá guardar as minhas opiniões para mim próprio - não; -))) e adicionar a lista gerada no Passo 4 a isto .arquivo de livro (ele mantém a lista de arquivos no final, tornando a vida realmente fácil). Não se esqueça de corrigir os caminhos relativos, se necessário com um pesquisa/substituição global (é por isso que precisava de pelo menos um ficheiro adicionado no Passo 3 - para ver qual o padrão de localização do ficheiro que o htmldoc espera);
Agora você deve ordenar os arquivos em uma ordem conveniente. Eu coloquei minha visão geral primeiro, depois descrições de pacotes e cada classe, depois o índice completo, e tudo o resto no final. Lembre-se que qualquer arquivo que você excluir se tornará um link externo (portanto quebrado), por isso escolha sabiamente;
Salva a tua .livro o ficheiro e reabre-o no HTMLDOC. Pronto: todos os ficheiros adicionados e ordenados. Carregue em gerar. É isso!
Poderá querer mexer com as imagens (DICA: use a largura/altura do HTML, não o estilo/css). No final, o arquivo resultante é surpreendentemente bom: bonito olhar e totalmente navegável para links internos e externos. Impressionante quando você considera que a ferramenta não é Java(Doc) ciente de tudo...
Se esta questão foi levantada de qualquer forma, posso usar isto para ligar o meu projecto ltxdoclet.
Isto cria a partir da documentação fonte (por ser um plugin JavaDoc) no formato LaTeX, que você então pode passar através PdfLaTeX para produzir um PDF.
Opcionalmente, também pode incluir um código fonte bastante impresso.O AurigaDoclet não processa o pacote.galeria. Para uma correcção veja o meu comentário em https://sourceforge.net/projects/aurigadoclet/forums/forum/339169/topic/1572199/index/page/1