Doxygen et QtCreator [Résolu]

[knopix77]

Bonjour a tous,

J'aimerai savoir si QtCreator intègre un plugin pour mettre automatiquement les commentaires Doxygen dans le code à la manière de Eclipse pour la javadoc ??

Parce que c'est long de ce taper toutes la doc à la main

Sinon est ce que vous connaissez un outils pour le faire indépendamment de Qtcreator



Pour être plus explicite, je voudrais un truc comme ca :

Code :

int foo( double value);

ca devient

Code :

1
2
3
4
5
6
/**
  * @fn foo fonction test
  * @param value valeur de test
  * @return un int
  */
int foo( double value);

à l'aide d'un raccourci clavier

[sardik]

Je ne pense pas que cela existe, tu dois te "taper" la documentation à la main.

[knopix77]

Bon tant pis je continue a chercher si je trouve quelque chose je le posterai.

[Gulish]

Voila une bonne idée de plug-in à développer .

Si tu trouves en effet quelquechose, merci de le partager !

G.

[knopix77]

Bon alors j'ai trouvé un petit plugin pour gVim :
http://www.vim.org/scripts/script.php?script_id=674

Il suffit de sélectionner la ligne de la fonction à commenter et de taper ox



Pour les fainéants (comme moi ) une petite commande à taper dans gVim :
":map <F2> ox<CR><Esc>"

Comme ça juste a ouvrir le source avec gVim a cliquer sur les lignes voulu et d'appuyer sur F2 ça génère bien le squelette doxygen.


Je continue à chercher on sait jamais ^^

[kofee]

Bonsoir,

J'étais dans le même cas et à force de ne pas trouver j'ai fini par mettre les mains dans le cambouis ce matin.

Attention le code est vraiment dégueulasse pour l'instant mais ça fait le job dans la plupart des cas je pense (je n'ai pas tout tout testé encore).

http://dev.kofee.org/QtCreator-Doxygen/

Voila, si ça intéresse

[yan]

Envoyé par kofee

Bonsoir,

J'étais dans le même cas et à force de ne pas trouver j'ai fini par mettre les mains dans le cambouis ce matin.

Attention le code est vraiment dégueulasse pour l'instant mais ça fait le job dans la plupart des cas je pense (je n'ai pas tout tout testé encore).

http://dev.kofee.org/QtCreator-Doxygen/

Voila, si ça intéresse

très très interessant. Justement, si y as bien un truc qui manque c'est cela!!!!
Par contre j'ai découvert (tous à l'heure) qu'il y as déjà l'auto complétion doxygen. Mais rien d'automatique

Peut tu expliquer un peu plus ce que fait ton plugin et comment l'ajouter à QtCreator?
C'est compliqué de créer un plugin pour QtCreator?

[kofee]

Oui justement en codant ça je suis tombé sur des gros fichiers de définition pour Doxygen qui annoncent un support digne de ce nom (mais quand :-?)

Alors pour ce que fait le plugin, bon, déjà il s'instancie et c'est déjà pas mal, mais après il installe une action avec un raccourci clavier et une entrée dans le menu contextuel de l'éditeur C++. Après ça la méthode de génération de doc est appelée à la demande, elle obtient la postion du curseur et à partir de la on peut retrouver le texte et analyser tout ça. (voir le site et le code pour le reste pour l'instant vu que je commence juste :p)

C'est pas facile facile de faire un plugin tierce partie pour l'instant puisque le plus gros de leur API n'est pas exposée directement et clairement (ou de manière pratique et documentée... mais ça va venir je leur fais confiance). Donc on se retrouve avec des tonnes d'inclusions et de paramètres à passer au linker. Sans compter l'exploration des namespace qui foisonnent... bien codé leur truc

D'où mon approche dégueulasse actuelle avant de trouver exactement sur quels boutons appuyer pour que ce soit propre. Puisque je suis sûr que la plupart des fonctions demandées pour réaliser cette tâche sont déjà codées dedans mais pas relièes. Mais ça fait du bien de plus taper tout le squelette à la main :-D

Pour les gens sous Linux ça va être facile à installer, mais pour Windows le linker gueule pour l'instant chez moi... je vais voir si je peux faire des binaires win32, mais 64bits je pourrais pas...


Edit2: bibliothèque binaire pour qtcreator-1.3.0-rc1 win32 disponible http://dev.kofee.org/QtCreator-Doxyg...2.0.0.1-r8.zip

[kofee]

Il ne manque plus que des testeurs et des suggestions (seulement sur les fonctionnalités, pour la propreté du code c'est déjà commencé mais pas commit )

[yan]

Envoyé par kofee

Il ne manque plus que des testeurs et des suggestions (seulement sur les fonctionnalités, pour la propreté du code c'est déjà commencé mais pas commit )

tu as fait des binaires win32 cooool.
Je teste quand je peut.

[kofee]

Bonjour,

Nouveaux binaires avec le début de la configuration du plug-in et le lancement de l'executable doxygen depuis QtCreator

[yan]

ca marche plutôt pas mal avec la dernière version de Qt Creator

juste quelques remarques ou suggestion :
* lorsque l'on fait "create doxygen ..." avec le curseur juste au dessus de l'entité (fonction,classe,...) il créé la doc pur l'entité du dessus.
* il n'y as pas de fonction de mise à jour. Par exemple, on ajoute un paramètre à un fonction.
* on peut pas choisir le style des commentaires :

/*!
* \brief ryzeuryzie
* \param fi fuefyeyziu
*/

*on ne peut pas modifier le fichier Doxygen par defaut.
* est il utile de mettre les balises @class, @fn, .... vue que ce que tu rajoute est juste au dessus et rend ces balise optionnel?

Si seulement j'avais eu ton plugin quand j'ai fait la lib pour le défis Qt...

[kofee]

Bonsoir,

Envoyé par yan

* lorsque l'on fait "create doxygen ..." avec le curseur juste au dessus de l'entité (fonction,classe,...) il créé la doc pur l'entité du dessus.

Exact, j'avais remarqué ce "détail" plus que gênant et je regarderai ce que je peux faire à ce sujet, en fait je verrai si ce comportement est toujours présent après avoir réécrit le parser en utilisant les include AST*.

Envoyé par yan

* il n'y as pas de fonction de mise à jour. Par exemple, on ajoute un paramètre à un fonction.

Oui, mais ça c'est plutôt coquin à faire et je m'attaquerai à ça après avoir réécrit le parser pour la génération. Ça représente beaucoup plus de travail et de recherche dans le code source. Idem pour la génération de doc sur tout un fichier source, j'en ai envie, je le prévois, mais c'est pas pour tout de suite.

Envoyé par yan

* on peut pas choisir le style des commentaires :
[...]
*on ne peut pas modifier le fichier Doxygen par defaut.

Ce sera fait pour la version 0.0.3, j'ai déjà commencé à poser les bases pour, reste le problème de réécrire le parser et ajouter une nouvelle classe dédiée

Envoyé par yan

* est il utile de mettre les balises @class, @fn, .... vue que ce que tu rajoute est juste au dessus et rend ces balise optionnel?

Idem, ce sera entièrement configurable dans la prochaine version.
Je l'ai mis pour l'instant puisque 1) je test et explore encore et 2) on peut avoir envie (ou l'obligation si en entreprise où c'est la norme) de bouger la doc du .h vers un autre fichier dédié et dans ce cas ces infos sont nécessaires.

Je ne sais pas quand je pourrai la sortir (enfin la coder surtout), j'ai quelques
choses urgentes à faire à un niveau moins ludique mais merci pour les remarques, je prends en compte.
Faut pas à hésiter à en faire plus et/ou ouvrir des tickets

Envoyé par yan

Si seulement j'avais eu ton plugin quand j'ai fait la lib pour le défis Qt...

Et moi depuis un moment aussi... c'est une fonctionnalité de Kdevelop 3.5 qui me manquait ENORMEMENT.

[Luc Hermitte]

Envoyé par knopix77

Bon alors j'ai trouvé un petit plugin pour gVim :
http://www.vim.org/scripts/script.php?script_id=674

A ce compte là, le mien détecte le sens des paramètres, la présence de spécifications d'exception (des fois des gens on de drôles d'idées...), s'il y a un type de retour ou non, et le style est configurable.

[gbdivers]

Bonjour Kofee

Quelques petites modifications que j'ai du faire pour compiler avec la version 1.3.80 de Qt Creator (version de développement).

Dans src/shared/cplusplus/CppDocument.h :

Code :

Document::Ptr CPlusPlus::Snapshot::value(const QString &fileName) const;

n'existe plus et devient:

Code :

Document::Ptr CPlusPlus::Snapshot::document(const QString &fileName) const;

Dans src/shared/cplusplus/Symbol.h :

Code :

Name* CPlusPlus::Symbol::name() const;

devient :

Code :

const Name* CPlusPlus::Symbol::name() const;

il faut donc changer le fichier doxygen.cpp :

Code :

1
2
3
ligne 86  : Name *name = owner->name();
ligne 106 : Document::Ptr doc = snapshot.value(editor->file()->fileName());
ligne 170 : Name *name = lastSymbol->name();

en :

Code :

1
2
3
ligne 86  : const Name *name = owner->name();
ligne 106 : Document::Ptr doc = snapshot.document(editor->file()->fileName());
ligne 170 : const Name *name = lastSymbol->name();

Peut être à ajouter :
* visualiser les pages html dans Qt Creator (mise à jour automatiquement de la page consultée) pour permettre de passer directement entre le code et la documentation générée.
* ajouter une barre de progression semblable à celle qui apparait lorsque l'on compile en bas à gauche (utiliser la classe ProgressManager)

EDIT : et pourquoi pas un éditeur graphique de doc doxygen ? tu génères la doc en html à partir des fichiers sources et tu ajoutes de boutons d'édition dans le code html et tu affiches tout ça dans Qt creator. Ca serait pas mal

Un plugin vraiment intéressant.

[mak972]

Bonjour,

J'ai essayer de compiler ton plugin pour Mac mais il manque des headers.
Tous les headers :
- coreplugin
- plugins
- libs

Je pense qu'il me manque des librairies pour compiler pour des plugins pour ce dernier ou bien elle sont placer a un autre endroit.

[yan]

Salut

Envoyé par mak972

Bonjour,

J'ai essayer de compiler ton plugin pour Mac mais il manque des headers.
Tous les headers :
- coreplugin
- plugins
- libs

Je pense qu'il me manque des librairies pour compiler pour des plugins pour ce dernier ou bien elle sont placer a un autre endroit.

A mon avis, il faut que tu parte des source de QtCreator pour faire un plugin. A moins que tous sois fournie dans les repertoir de QtCreator.

[gbdivers]

Les sources de Qt Creator ne sont pas dans le SDK. Il faut les télécharger séparément. Tu les trouveras là : http://qt.gitorious.org/qt-creator/q...-tarball/1.3.1 (pour la version 1.3.1 de Qt Creator, c'est à dire celle qui est fournit dans le SDK)

Tu décompresse le tout dans un répertoire (de préférence pas celui contenant Qt, ça serait dommage de ne plus avoir accès au Qt Creator du SDK si ta compilation ne fonctionne pas) et ensuite tu compiles (personnellement, j'avais compilé Qt Creator avant le plugin de doxygen, je ne sais pas si c'est indispensable).

De plus, j'avais modifié le projet pour que la compilation de ce plugin soit identique aux autres plugins (et j'ai donc déplacer les sources dans le repertoire src/plugins/qtcreator-doxygen)

A priori, pas trop de problème pour compiler si Qt est correctement installé

[mak972]

Une fois qt creator compiler sa devient un peux la guerre.

Je voudrait savoir de quelle librairie tu a besoin pour le faire fonctionner.

Code :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Define QTC_SOURCE_DIR to the location of Qt Creator sources (i.e: ~/dev/qtcreator/qt-creator-src/)
unix:QTC_SOURCE_DIR = /home/kofee/dev/qtcreator/qt-creator-1.3.0/
win32:QTC_SOURCE_DIR = C:/Qt/dev/qt-creator-1.3.0/
else:QTC_SOURCE_DIR = /Users/macko_j/Projets/qt-creator-1.3.1-src/
IDE_SOURCE_TREE = $$QTC_SOURCE_DIR
 
# Define QTC_BUILD_DIR to the location of Qt Creator build dir for the plugin (i.e ~/dev/qtcreator/doxygen/)
unix:QTC_BUILD_DIR = /home/kofee/dev/qtcreator/qtcreator-doxygen/
win32:QTC_BUILD_DIR = C:/Qt/dev/qtcreator-doxygen/
else:QTC_BUILD_DIR = /Users/macko_j/Projets/qtcreator-doxygen/
IDE_BUILD_TREE = $$QTC_BUILD_DIR
 
# Define DESTDIR to the local location of the installation of Qt creator (if local user)
# or the system location if building as root
DESTDIR = lib/qtcreator/plugins/$$(PROVIDER)
unix:LIBS += -L/usr/lib/qtcreator \
    -L/usr/lib/qtcreator/plugins/Nokia \
    -L/usr/lib/qt4
win32:LIBS += -LC:/Qt/4.6.0/lib \
    -LC:/Qt/dev/qt-creator-1.3.0/lib/qtcreator/plugins/Nokia \
    -LC:/Qt/dev/qt-creator-1.3.0/lib/qtcreator
else:LIBS +=
    -LC:/Developer/Applications/Qt/Qt Creator.app/Contents/PlugIns/Nokia/ \
    -LC:/Developer/Applications/Qt/Qt Creator.app/Contents/Frameworks/

Cette dernière ligne déconne il manque /Qt/4.6.0/lib ce qui je pense signifie que je dois compiler aussi Qt...

Je m'y met et je regarde ce qui ce passe parce que pour le coup j'ai aucune lib j'ai du taper dans celle de Qt Creator et apparemment il n'aime pas vraiment.

[gbdivers]

Si tu as réussit à compiler Qt Creator, c'est que tu as toutes les libs et que Qt est correctement configuré.

Donc c'est simplement un problème de configuration de la lib (en particulier les chemins des libs sous mac)

Personnelement, j'utilise la configuration de base des plugins de Qt Creator. Déplace le répertoire dans QTCREATOR_DIR/src/plugins/Doxygen/ et crée le fichier "Doxygen.pro"

Code :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
TEMPLATE = lib
TARGET = Doxygen
QT += network
include(../../qtcreatorplugin.pri)
include(Doxygen_dependencies.pri)
HEADERS += doxygenplugin.h \
    doxygen_global.h \
    doxygenconstants.h \
    doxygen.h \
    doxygensettings.h \
    doxygensettingswidget.h \
    doxygensettingsstruct.h
SOURCES += doxygenplugin.cpp \
    doxygen.cpp \
    doxygensettings.cpp \
    doxygensettingswidget.cpp \
    doxygensettingsstruct.cpp
FORMS += doxygensettingswidget.ui
OTHER_FILES += Doxygen.pluginspec
DEFINES += DOXYGEN_LIBRARY

Ouvre ensuite ce fichier Doxygen.pro avec Qt Creator et lance la compilation. Ca devrait fonctionner.

EDIT: j'ai oublié le fichier de dépendance : Doxygen_dependencies.pri

Code :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
include(../../plugins/coreplugin/coreplugin.pri)
include(../../plugins/texteditor/texteditor.pri)
include(../../plugins/cppeditor/cppeditor.pri)
include(../../plugins/designer/designer.pri)
include(../../libs/cplusplus/cplusplus.pri)
include(../../shared/cplusplus/cplusplus.pri)
INCLUDEPATH += ../../src \
    ../../plugins \
    ../../libs \
    ../../libs/cplusplus \
    ../../libs/extensionsystem \
    ../../libs/utils \
    ../../shared \
    ../../shared/cplusplus