Inclusion d’images dans des javadocs

Comme vous n’avez montré aucune source, je ne peux que deviner une boule de verre …

Pour tous les fichiers nécessaires à la documentation, vous devez les placer dans un sous-répertoire nommé doc-files de vos répertoires de paquets. Celles-ci seront alors simplement copiées par Javadoc dans le répertoire de sortie. Ensuite, utilisez un chemin relatif dans l’élément .

Je ne sais pas si le moteur de rendu Javadoc de votre IDE fera de même, mais cela vaut la peine d’essayer.

Un peu exagéré, mais vous pouvez intégrer les images de la documentation en les convertissant en Base64. Cela ressemblerait à ceci:

Il existe des outils en ligne disponibles pour effectuer la conversion:

• http://www.base64-image.de
• http://daturi.me
• http://www.freeformatter.com/base64-encoder.html

Avec Eclipse Luna, ce qui suit fonctionne pour moi.

• com
  • compagnie
    • un paquet
      • fichiers doc
        • image.png
      • Test.java

Maintenant dans le javadoc de Test.java:

 /** *  */ 

Et Eclipse affiche l’image à la fois dans l’aide contextuelle, lorsque vous survolez la souris et dans la vue Javadoc.

Vous pouvez même append style="width: 100%;" à la balise img , de sorte que l’image s’ajuste à la taille de la vue / popup.

Pour développer un peu la réponse de Paŭlo en supposant que la construction Maven est ce qui a fonctionné pour moi avec JDK-8 (validation HTML plus ssortingcte), avec la stipulation que vous êtes prêt à exécuter l’outil javadoc.

Malheureusement, avec Netbeans, je ne peux pas voir l’image dans la fenêtre contextuelle javadoc de l’EDI, je viens d’ouvrir ce bogue netbeans .

Supposons que cela fasse partie du javadoc pour com.foo.File.java (notez qu’aucune balise de fin d’img, qui est la bonne méthode par w3schools):

Dans la structure du répertoire maven, vous trouverez l’image ici: src/main/javadoc/com/foo/https://stackoverflow.com/questions/10779169/including-images-in-javadocs/doc-files/foo.png

Et enfin, dans le fichier pom.xml (notez que docfilessubdirs est défini sur true):

    org.apache.maven.plugins maven-javadoc-plugin 2.10.3  true   ... 

Je suis tombé sur cette question car je voulais aussi montrer un aperçu de mes icons. Après avoir lu les réponses, je n’étais pas encore satisfait et l’ai essayé pour moi-même. C’est ce que j’ai maintenant:

  /** * 
 * Icon for myImage. * * @return the icon */ 

comme cela, je n’ai pas besoin de gérer plus d’images qu’auparavant en allant simplement dans le dossier contenant les images réelles.

Pour approfondir un peu la réponse de Vsevolod Golovanov et Paulo Ebermann ci-dessus, voici un exemple concret et un développement ultérieur.

La documentation Javadocs indique:

Pour inclure des fichiers non traités, placez-les dans un répertoire appelé doc-files, qui peut être un sous-répertoire de tout répertoire de paquets contenant des fichiers source.

Si vous placez les fichiers image dans ce dossier, ils seront disponibles pour les fichiers HTML Javadocs via le chemin relatif du code HTML généré.

Donc, si votre projet s’appelle MyProject et que la classe à laquelle vous ajoutez des commentaires Javadoc est org.foo.app.MyApp , le dossier source correspondant est MyProject / src / org / foo / app / MyApp.java et vous voulez inclure MyImage.jpg dans son Javadoc, puis:

Créez le dossier MyProject / src / org / foo / app / doc-files et placez-y le fichier image.

À ce stade, votre texte Javadocs peut le référencer ainsi:

Et le code HTML généré par Javadocs sera codé en conséquence.

Notez l’atsortingbut “width”, permettant la mise à l’échelle de l’image. La hauteur est mise à l’échelle proportionnellement.

Lorsque vous exécutez Javadocs, les dossiers doc-files seront tous copiés dans les dossiers de sortie Javadocs et leurs ressources seront disponibles pour le HTML.