Y compris les images dans la documentation javadoc

Je travaille avec beaucoup d'exemples de cas de tests visuels. Est-il un moyen commode de les inclure dans mon Java de la source et lien dans la documentation Javadoc, donc mon IDE peut automatiquement leur montrer lors de l'encodage (par l'invocation d'une javadoc rendu dans mon IDE?)

J'ai essayé de mettre une image à côté de la source de Java et l'utilisation de <img>, mais il ne le prend pas (j'ai utilisé un png).

(note - il est dans mon sources de test dans ce cas)

  • Pourquoi ne pas nous montrer ce que vous essayez de le faire avec un peu de code? Utiliser le modifier lien pour l'ajouter. Bonne chance! 🙂
  • ceci ce que vous essayez d'atteindre?
InformationsquelleAutor ianpojman | 2012-05-28
  1. 20

    Que vous n'avez pas de sources, je ne peux faire un verre ballon deviner ...

    Pour tous les fichiers qui sont nécessaires à des fins de documentation, on devrait les mettre dans un sous-répertoire nommé doc-files de vos répertoires de paquets. Elles seront tout simplement copié par Javadoc dans le répertoire de sortie. Ensuite, utilisez un chemin relatif dans la <img> élément.

    Je ne suis pas sûr si votre IDE de la Javadoc rendu sera le même, mais il vaut la peine d'essayer.

    • merci - mais qui m'oblige à exécuter l'utilitaire javadoc, qui je l'espère, d'éviter (et probablement fait de cette situation impossible...)
    • Téléchargement de l'image sur un site comme imgur fonctionne un régal: <img src="https://i.imgur.com/GPzGu1N.png" /> En action dans IntelliJ
    InformationsquelleAutor Paŭlo Ebermann
  2. 30

    Un peu tiré par les cheveux, mais vous pouvez inline les images dans la documentation en les convertissant en Base64. Il devrait ressembler à ceci:

    <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..." />

    Il existe des outils en ligne pour faire la conversion:

    • Vous pouvez utiliser une image normale comme l'a expliqué Paulo, mais que signifie un fichier séparé pour gérer.
    • C'est mon dernier recours, ici, depuis le dessin en ascii art dans la documentation Javadoc est trop douloureux.....
    • inteliJ ne pas voir cette image
    • J'ai trop l'habitude de l'encodage base64 dans l'affichage de l'image. Lorsque l'application est exécutée à partir de l'Ide, à l'image parfois vide. Mais les œuvres même lorsque l'application est exécutée dans l'isolement après le déploiement. Quelque chose de mal que je suis en train de faire?
    InformationsquelleAutor Emmanuel Bourg
  3. 9

    Avec Eclipse Luna la suivante fonctionne pour moi.

    • com
      • société
        • somepackage
          • doc-files
            • image.png
          • Test.java

    Maintenant dans Test.java's javadoc:

    /**
 * <img src="./doc-files/image.png" />
 */

    Et Eclipse affiche l'image à la fois dans la popup d'aide, lorsque vous placez le pointeur de la souris, et dans la Javadoc de la Vue.

    Vous pouvez même ajouter style="width: 100%;" à la img marque, de sorte que l'image s'adapte à la vue/taille de fenêtre contextuelle.

    • Android Studio 3.0 (un.k.un IntelliJ) affiche l'image dans le "Rapide de la Documentation" qui s'affiche.
    InformationsquelleAutor Vsevolod Golovanov
  4. 3

    Développer un peu Paŭlo réponse en supposant une maven build voici ce qui a fonctionné pour moi avec JDK-8 (plus strictes de la validation HTML), avec la stipulation que vous êtes prêt à exécuter l'outil javadoc.

    Malheureusement avec Netbeans, je ne vois pas l'image dans l'IDE de la javadoc de pop-up, je viens d'ouvrir cette netbeans bug.

    Suppose que c'est une partie de la javadoc de com.foo.File.java (avis n img balise de fin, qui est la voie droite par w3schools):

    <img src="doc-files/foo.png" alt="Foo">

    Dans le maven structure de répertoire, vous trouverez l'image ici: src/main/javadoc/com/foo/doc-files/foo.png

    Et le dernier, dans le pom.xml (avis docfilessubdirs est définie à true):

    <build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.10.3</version>
            <configuration>
                <docfilessubdirs>true</docfilessubdirs>
            </configuration>
        </plugin>
        ...
    InformationsquelleAutor Jason
  5. 1

    Je suis tombé sur cette question, comme je l'ai ainsi voulu montrer un aperçu de mes icônes. Après avoir lu les réponses, je n'étais pas encore satisfait et il a essayé par moi-même. C'est ce que j'ai maintenant:

         /**
     * <img src="../../../../../../resources/com/my/project/client/images/myImage.png"><br>
     * Icon for myImage.
     *
     * @return the icon
     */

    comme ça je n'ai pas besoin de gérer des images de plus qu'avant en allant simplement dans le dossier de l'effectif des images se situent dans.

    InformationsquelleAutor BAERUS
  6. 1

    Essayer de cette façon,

    /**
 * @author KamyninSA
 * @version 1
 * <p><b>Description</b></p>
 * <p><img src="{@docRoot}/../src/test/resources/doc-files/ads.png" alt="alternative directory"></p>
 * */
    InformationsquelleAutor Сергей Камынин
  7. 0

    D'étendre un peu sur Vsevolod Golovanov et Paulo Ebermann la réponse ci-dessus, voici un exemple concret et une élaboration plus poussée.

    La Javadoc états de documentation:

    Pour inclure non transformés, les fichiers, les mettre dans un répertoire appelé doc-des fichiers qui peuvent être un sous-répertoire d'un paquet répertoire qui contient les fichiers source.

    Si vous placez les fichiers d'image dans ce dossier, il sera disponible à la documentation Javadoc fichiers HTML via le chemin relatif depuis le code HTML généré.

    Donc, si votre projet est nommé MyProject et la classe de l'ajout de commentaire Javadoc est org.foo.app.MyApp, le dossier source pour ce qui est de MyProject/src/org/foo/app/MyApp.java et vous souhaitez inclure MyImage.jpg dans sa Javadoc, puis:

    Créer le dossier MyProject/src/org/foo/app/doc-files, et placez le fichier image en elle.

    À ce point de votre documentation Javadoc de texte peut faire référence ainsi: 

    <img src="doc-files/MyImage.jpg" width="500" alt="description of MyImage">

    Et les Javadocs HTML générée reflètent être codé en conséquence.

    Note la "largeur" de l'attribut, permettant la mise à l'échelle de l'image. La hauteur est ajustée proportionnellement.

    Lorsque vous exécutez la documentation Javadoc, le doc-files les dossiers de tous les être copié dans la Javadoc de sortie des dossiers et les ressources seront disponibles pour une utilisation par le HTML.

    InformationsquelleAutor Roger Neyman