J'ai documenté avec Javadoc et j'ai beaucoup apprécié l'intégration avec Eclipse mais je voulais utiliser Doxygen pour ajouter des diagrammes. J'utilise les balises {link foo} dans plusieurs brèves descriptions pour les lier à des classes Java standard et à mes propres classes.Javadoc tag @link avec Doxygen: impossible de résoudre le lien
Voici un SSCCE:
package org.foo.myproject;
import javax.swing.JList;
/**
* This is a Javadoc line {@link JList}
*
* @author theauthor
* @version 1.0.0
*/
public class JavadocLinkFailedDemo {
}
Je reçois l'erreur suivante avec Doxygen (1.8.4): Warning: unable to resolve link to JList for \link command
(j'utiliser un modèle de Doxyfile généré avec doxygen.exe, édité pour .java sources et entrée spécifiques/ouput directories)
Ceci est un problème similaire avec ce question mais la solution de l'auteur du sujet n'a pas fonctionné pour moi.
Merci pour votre aide à l'avance.
EDIT1: J'ai juste essayé de générer l'API Java avec doxygen pour obtenir le fichier de balise correspondant. Ensuite, j'ai utilisé ce fichier avec ce projet de démo où j'ai ajouté un constructeur en utilisant un paramètre comme JList => Le lien est résolu uniquement pour ce paramètre, jamais avec une commande link.
EDIT2: Je réussis enfin à garder ce genre de signature: {@link ...}. Pour mon exemple, JList est résolu si vous remplissez les conditions suivantes:
- Écrivez le nom complet du fichier de classe
- Générez la documentation de jdk avec doxygen pour générer un fichier de balise et utilisez cette balise dans votre projet
Le code exemple final est:
package org.foo.myproject;
import javax.swing.JList;
/**
* This is a Javadoc line with {@link javax.swing.JList}
*
* @author theauthor
* @version 1.0.0
*/
public class JavadocLinkFailedDemo {
/**
* This is a Javadoc line of the constructor with {@link javax.swing.JList}
*
* @param aList
* The list
*/
public JavadocLinkFailedDemo(JList aList) {
}
}
Le résultat final:
Cependant, il est presque impossible de créer un fichier d'aide .chm car il faut du temps pour effectuer cette tâche et vous obtenez un très gros fichier. Mais c'est un autre problème ...
a modifié ma réponse – aldr