Comment générer un PDF à partir de JavaDoc (y compris un aperçu et des résumés de paquets)

Cloué. Après avoir essayé tous les outils possibles pour générer directement à partir de la source, je suis revenu à HTMLDOC. Ce n'est pas JavaDoc-aware, mais il est si bien construit que quelques ajustements suffisent pour le faire générer un PDF assez utilisable.

Voici une description étape par étape de la façon dont je l'ai fait:

1. Téléchargez une version gratuite du logiciel (la version officielle du site nécessite une licence, mais elle est GPL-ed, vous pouvez donc trouver des binaires gratuits tels que celui-ci, qui est un installateur simple et fonctionnel pour Windows);

2. Générez vos documents HTML traditionnels de votre manière préférée (Ant, Maven, javadoc en ligne de commande-votre choix);

3. L'interface graphique est agréable, mais ajouter tous les fichiers manuellement peut être lourd, il suffit donc de créer un .fichier livre avec le type de document défini sur "Page Web", ajoutez l'un des fichiers HTML du dossier racine de votre javadoc généré (par exemple, overview-summary.html, tout le monde le fera, c'est juste pour référence à l'étape 5). Sur le Onglet Sortie sélectionnez le format PDF et définissez-lui un nom, et ajoutez d'autres options au contenu de votre cœur (logos, couleurs, beaucoup de choses cool ici). Enregistrez ce projet (disons, myjavadocpdf.book) et fermez l'interface graphique

4. Générez une liste de tous les fichiers HTML de votre javadoc. Je l'ai fait avec la commande find de Cygwin (mes jours de shell DOS/cmd sont longs), mais vous pouvez faire tout ce que vous voulez, tant que vous obtenez une liste de fichiers. Dans mon cas, un find . | grep html$ | sort -r > files.txt a fait l'affaire; Pour les utilisateurs Windows, dir /s/b *.html > files.txt devrait faire la même chose (mais gardez à l'esprit que vous pouvez avoir à remplacer \s /s si elles apparaissent comme sur l'étape suivante).

5. Ouvrez le .fichier de livre généré à l'étape 3 dans votre éditeur de texte pur préféré (en tant que programmeur, vous devriez avoir de fortes opinions à ce sujet, donc garderez mes opinions pour moi - PAS ;-) ) et ajoutez la liste générée à l'étape 4 à cela .fichier livre (il conserve la liste des fichiers à la fin, ce qui rend la vie vraiment facile). N'oubliez pas de corriger les chemins relatifs, si nécessaire avec un recherche/remplacement global (c'est pourquoi vous aviez besoin d'au moins un fichier ajouté à l'étape 3 - pour voir quel modèle de chemin de fichier htmldoc attend);

6. Maintenant, vous devez trier les fichiers dans un ordre pratique. J'ai d'abord mis mon aperçu, puis les descriptions de package et chaque classe, puis l'index complet, et tout le reste à la fin. N'oubliez pas que tout fichier que vous supprimez deviendra un lien externe (donc cassé), alors choisissez judicieusement;

7. Enregistrez votre .réservez le fichier et rouvrez-le sur HTMLDOC. Voila: tous les fichiers ajoutés et triés. Cliquez sur générer. Ça y est!

Vous voudrez peut-être jouer avec des images (indice: utilisez la largeur/hauteur HTML, pas le style/css). En fin de compte, le fichier résultant est étonnamment bon: joli et entièrement navigable pour les liens internes et externes. Impressionnant quand on considère que l'outil n'est pas du tout conscient de Java(Doc)...