web-dev-qa-db-fra.com

Comment utiliser eclox, le plugin doxygen pour Eclipse

Comment faire fonctionner eclox dans Eclipse 3.5?

J'utilise Ubuntu 9.04. J'ai installé Doxygen à partir de référentiels Ubuntu (version 1.5.8). Ensuite, j'ai installé eclox sur Eclipse via le site de mise à jour.

Malgré cela, je n’obtiens aucune option dans aucun menu pour l’initier.

De plus, le site eclox ne semble pas avoir de guide de démarrage.

S'il vous plaît aider.

eclipseeclipse-plugindoxygen
22
ruwan.jayaweera

Qu'à cela ne tienne, ça a fonctionné de mon côté.

Vous devez d’abord créer un fichier DoxyFile (qui est le fichier de configuration) en donnant le chemin source et le chemin de sortie.

Ensuite, vous seul pouvez générer la documentation en cliquant avec le bouton droit de la souris sur le projet et en sélectionnant "Générer la documentation".

Merci quand même!

16
ruwan.jayaweera

BTW il y a un manuel à l'intérieur de org.gna.eclox_0.8.0.jar, wierd ils ne l'ont pas posté sur le site du projet !!!

Voici le contenu

      Eclox, a Doxygen frontend plugin for Eclipse.
            <http://gna.org/projects/eclox>

  1. INSTALLATION

    Il existe deux options pour installer le plug-in: en utilisant le site de mise à jour ou .__ en utilisant la fonctionnalité packagée.

    Le site de mise à jour est le moyen le plus pratique d’installer eclox. Il est situé à https://anb0s.github.io/eclox . Voir l'utilisateur Guilde d'Eclipse pour plus de détails.

    Lorsque vous utilisez la fonctionnalité packagée, vous devez extraire le contenu de l'archive dans Votre emplacement racine Eclipse. Pour plus de détails, veuillez vous reporter au manuel d'utilisation Eclipse.

  2. CONFIGURATION

    Une fois le plugin installé, vous devez vous assurer que la variable d'environnement PATH par défaut rend le binaire doxygen accessible pour le plugin. Sinon, vous pouvez Mettre à jour PATH pour l'inclure dans un répertoire contenant le binaire Doxygen, ou vous pouvez Indiquer à Eclox où se trouve ce binaire sur votre système (ce qui, à mon avis, est la meilleure solution). Pour ce faire, ouvrez la fenêtre de dialogue d'édition de préférences d'Eclipse Et allez dans la nouvelle section "Doxygen".

  3. USAGE

    Vous pouvez créer de nouveaux projets Doxygen (également appelés fichiers doxy) à l'aide de l'assistant de création Allez dans "Fichier-> Nouveau-> Autre-> Autre-> Configuration Doxygen". Appuyez surnext et définissez l’emplacement et le nom du fichier. Ensuite, un fichier Doxy vide sera créé À l’emplacement spécifié, l’assistant ajoute automatiquement l’extension ". Doxyfile".

    Vous devriez maintenant voir un fichier avec une icône bleue @ -sign. Ceci est votre nouveau fichier Doxyfile. Double-cliquer dessus ouvrira l'éditeur. Vous pouvez maintenant parcourir et modifier les paramètres.

    Une fois que vous avez correctement défini tous les champs doxyfile, vous pouvez lancer une compilation de documentation À l’aide de l’icône de la barre d’outils affichant un signe @ bleu. Dans le cas où le bouton n'est pas visible dans la barre d'outils, votre perspective actuelle .__ doit être configurée. Allez dans "Fenêtre-> Personnaliser la perspective-> Commandes" et "in" Groupes de commandes disponibles "cochez" Doxygen ". De plus, vous pouvez parcourir les plus récentes constructions en cliquant sur la flèche vers le bas à droite du bouton de la barre d’outils.

    Lorsque la construction de la documentation commence, une nouvelle vue contenant le journal de la construction s'ouvre . Dans sa barre d'outils, un bouton nommé "Arrêter" vous permet d'arrêter le processus de construction en cours La version actuelle apparaît également dans la vue de progression du travail Eclipse et vous permet de contrôler le travail à partir de là.

    L'action de génération dans la barre d'outils détermine le fichier doxy suivant à construire en fonction de La partie active de l'atelier (éditeur ou vue) et de la sélection actuelledans cette partie. Par exemple, si la partie active est un éditeur de fichier doxy, le prochain fichier Doxyfile à générer sera celui en cours de modification. Si la partie active est l'explorateur de ressources Et que la sélection actuelle est un fichier doxy, ce fichier doxyfile serabe suivant pour obtenir la construction. Si la sélection de la pièce active ne correspond pasà un fichier Doxy, le dernier fichier Doxy créé sera reconstruit. Et si l'historique de compilation est vide, il vous sera demandé de créer le fichier doxy.

HTH n'importe qui

28
siva.p

Je viens de faire face à un problème de configuration du chemin binaire Doxygen dans les paramètres eclox 0.8.0 dans Eclipse sous Mac OS X 10.7 . Il n’existe aucun moyen de configurer le chemin via préférences Eclipse-> (Doxygen} _.

La solution consiste à modifier le fichier de préférences manuellement

  1. ajoutez un (faux) emplacement, disons /Applications, à l'aide de l'assistant mentionné ci-dessus.
  2. fermer Eclipse
  3. éditez ce fichier: $WORKSPACE/.metadata/.plugins/org.Eclipse.core.runtime/.settings/org.gna.eclox.core.prefs: Remplacez la valeur pour doxygen.default (actuellement eclox.core.doxygen.CustomDoxygen /Applications\n) par eclox.core.doxygen.CustomDoxygen /Applications/Doxygen.app/Contents/Resources/doxygen\n.
  4. redémarrer Eclipse
3
klaus

Pour les utilisateurs de MacOS, il existe un moyen très simple de se déplacer via le problème de la sélection de version de Doxygen. Le lien qui fournit des détails est ici: https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse

Après avoir installé le plug-in Eclox:

1) "allez à" Eclipse -> Préférences -> Oxygen " 2)" Appuyez sur Maj + CMD + G puis ajoutez: "/Applications/Doxygen.app/Contents/Resources/doxygen"3) La version de Doxygen devrait être affichée

1
MickaelT

Comme claus, je devais creuser dans le fichier de préférences manuellement, car eclox 0.8.0 ne prendrait pas le bon chemin du sélecteur de fichier de préférences Eclipse . Donc, éditez ce fichier: $WORKSPACE/.metadata/.plugins/org.Eclipse.core.runtime/.settings/org.gna.eclox.core.prefs et modifiez le chemin indiqué (dans mon cas, je a dû changer de 

doxygen.default=eclox.core.doxygen.CustomDoxygen C\:\\Programm Files\\doxygen\\bin

pour ça 

doxygen.default=eclox.core.doxygen.CustomDoxygen C\:\\Programme\\doxygen\\bin

J'espère que cela t'aides.

0
goeck

Je trouve une page Web https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse où vous pouvez trouver plus de détails. En particulier, pour les utilisateurs Mac, vous devez Appuyez sur Maj + CMD + G, puis sur Ajouter: "/Applications/Doxygen.app/Contents/Resources/doxygen" lorsque vous configurez le doxygen dans Eclipse avant de compiler .doxygfile à l'aide d'Eclox .

0
Yong Yang

Une alternative à Eclipse est d’utiliser Javadoc :

  1. Depuis le menu (... Search Project Run ...)

Projet> Générer Javadoc

  1. Vous devriez être dans un projet Java et ajouter des commentaires avec des balises.

!!!

0
adrian filipescu

cela pourrait vous aider ou aider tout utilisateur Windows à installer eclox:

Tutoriel pour l'installation d'éclox - Transcription du document

Étape 1: accédez au site Web eclox ( http://home.gna.org/eclox/ ) et copiez le lien update update.Step. 

étape 2: insérez le lien dans le gestionnaire de mise à jour dans Eclipse et appuyez sur OK.

Étape 3: Sélectionnez l’élément Eclox et terminez l’installation.

Étape 4: Une fois l’installation terminée, vous devez sélectionner le projet pour lequel vous souhaitez générer les documents désoxygénés. Créez ensuite un projet doxygen pour celui-ci.

Étape 5: configurez les options. Remarque: Vous devez fournir les «répertoires d'entrée» correctement et sélectionner l'élément «Analyser de manière récursive». Enfin, sauvegardez le fichier de configuration.

Étape 6: trouvez le «@» et choisissez «Choisissez un fichier Doxy ...».

Étape 7: sélectionnez un fichier doxy.Etape 8: attendez quelques secondes et les doublons seront générés.

son de ce lien: http://www.slideshare.net/pickerweng/tutorial-for-installing-eclox

0
j2emanue