Doxygen et QtCreator

Version imprimable

11/06/2009, 15h20
knopix77

Doxygen et QtCreator
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
11/06/2009, 15h28
sardik

Je ne pense pas que cela existe, tu dois te "taper" la documentation à la main.
11/06/2009, 15h54
knopix77

:pleure:

Bon tant pis je continue a chercher si je trouve quelque chose je le posterai.
11/06/2009, 16h07
Gulish

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

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

G.
11/06/2009, 16h20
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 :Dox

Pour les fainéants (comme moi :D) une petite commande à taper dans gVim :
":map <F2> :Dox<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 ^^
25/11/2009, 22h37
kofee

Doxygen et QtCreator

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 :)
25/11/2009, 23h30
yan

Citation:

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 :)

:king:
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?
26/11/2009, 00h06
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
28/11/2009, 14h00
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 :) )
28/11/2009, 14h08
yan

Citation:

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.
30/11/2009, 16h28
kofee

binaires win32

Bonjour,

Nouveaux binaires avec le début de la configuration du plug-in et le lancement de l'executable doxygen depuis QtCreator :)
02/12/2009, 20h44
yan

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

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 :

Citation:

/*!
* \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...
02/12/2009, 22h43
kofee

Bonsoir,

Citation:

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*.

Citation:

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.

Citation:

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 :)

Citation:

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 :)

Citation:

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.
18/12/2009, 14h00
Luc Hermitte

Citation:

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.
22/02/2010, 01h17
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.
23/02/2010, 17h34
mak972

Compilation Osx

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.
23/02/2010, 17h35
yan

Salut

Citation:

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.
23/02/2010, 18h09
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é

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.

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

Toujours le même bug que au tout début

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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
Exécution des étapes de compilation pour le projet doxygen...
Configuration non modifiée, passe l'étape QMake.
Lancement : /usr/bin/make -w
make: Entering directory `/Users/macko_j/Projets/qt-creator-1.3.1-src/src/plugins/doxygen'
g++ -c -pipe -g -gdwarf-2 -arch i386 -fvisibility=hidden -fvisibility-inlines-hidden -arch ppc -Wall -W -DIDE_LIBRARY_BASENAME=\"lib\" -DWITH_TESTS -DQT_NO_CAST_TO_ASCII -DDOXYGEN_LIBRARY -DQT_PLUGIN -DQT_TESTLIB_LIB -DQT_GUI_LIB -DQT_NETWORK_LIB -DQT_CORE_LIB -DQT_SHARED -I/usr/local/Qt4.6/mkspecs/macx-g++ -I. -I/Library/Frameworks/QtCore.framework/Versions/4/Headers -I/usr/include/QtCore -I/Library/Frameworks/QtNetwork.framework/Versions/4/Headers -I/usr/include/QtNetwork -I/Library/Frameworks/QtGui.framework/Versions/4/Headers -I/usr/include/QtGui -I/Library/Frameworks/QtTest.framework/Versions/4/Headers -I/usr/include/QtTest -I/usr/include -I. -I../../libs -I/Users/macko_j/Projets/qt-creator-1.3.1-src/tools -I../../plugins -I../../shared/cplusplus -I../../shared/cplusplus -I../../shared/cplusplus -I../../shared/cplusplus -I../../shared/cplusplus -I../../shared/cplusplus -I../../src -I../../plugins -I../../libs -I../../libs/cplusplus -I../../libs/extensionsystem -I../../libs/utils -I../../shared -I../../shared/cplusplus -I.moc/debug-shared -I.uic -F/Library/Frameworks -o .obj/debug-shared/doxygenplugin.o doxygenplugin.cpp
In file included from doxygenplugin.cpp:21:
doxygenplugin.h:24:42: error: libs/extensionsystem/iplugin.h: No such file or directory
In file included from doxygensettings.h:26,
from doxygenplugin.h:25,
from doxygenplugin.cpp:21:
doxygensettingswidget.h:25:36: error: libs/utils/pathchooser.h: No such file or directory
doxygenplugin.cpp:25:50: error: plugins/cppeditor/cppeditorconstants.h: No such file or directory
doxygenplugin.cpp:26:48: error: plugins/cpptools/cpptoolsconstants.h: No such file or directory
doxygenplugin.cpp:28:38: error: plugins/coreplugin/icore.h: No such file or directory
doxygenplugin.cpp:29:46: error: plugins/coreplugin/coreconstants.h: No such file or directory
doxygenplugin.cpp:30:60: error: plugins/coreplugin/actionmanager/actionmanager.h: No such file or directory
doxygenplugin.cpp:31:54: error: plugins/coreplugin/actionmanager/command.h: No such file or directory
doxygenplugin.cpp:32:48: error: plugins/coreplugin/uniqueidmanager.h: No such file or directory
doxygenplugin.cpp:33:54: error: plugins/coreplugin/editormanager/ieditor.h: No such file or directory
doxygenplugin.cpp:34:60: error: plugins/coreplugin/editormanager/editormanager.h: No such file or directory
doxygenplugin.cpp:36:47: error: plugins/coreplugin/messagemanager.h: No such file or directory
doxygenplugin.cpp:37:45: error: plugins/projectexplorer/project.h: No such file or directory
doxygenplugin.cpp:38:53: error: plugins/projectexplorer/projectexplorer.h: No such file or directory
doxygenplugin.cpp:39:45: error: plugins/projectexplorer/session.h: No such file or directory
doxygenplugin.cpp:40:62: error: plugins/projectexplorer/projectexplorerconstants.h: No such file or directory
doxygenplugin.cpp:41:50: error: plugins/projectexplorer/outputwindow.h: No such file or directory
doxygenplugin.cpp:42:34: error: libs/utils/qtcassert.h: No such file or directory
doxygenplugin.cpp:43:43: error: libs/utils/synchronousprocess.h: No such file or directory
doxygenplugin.cpp:44:40: error: libs/utils/parameteraction.h: No such file or directory
doxygenplugin.cpp:45:48: error: libs/extensionsystem/pluginmanager.h: No such file or directory
In file included from doxygenplugin.cpp:21:
doxygenplugin.h:41: error: 'ExtensionSystem' has not been declared
doxygenplugin.h:41: error: expected `{' before 'IPlugin'
doxygenplugin.h:41: error: function definition does not declare parameters
doxygenplugin.cpp:53: error: 'ExtensionSystem' is not a namespace-name
doxygenplugin.cpp:53: error: expected namespace-name before ';' token
doxygenplugin.cpp:65: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:67: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:71: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:75: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:123: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:127: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:131: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:137: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:142: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:209: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:214: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:221: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp: In function 'QObject* qt_plugin_instance()':
doxygenplugin.cpp:285: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
In file included from doxygenplugin.cpp:21:
doxygenplugin.h:24:42: error: libs/extensionsystem/iplugin.h: No such file or directory
In file included from doxygensettings.h:26,
from doxygenplugin.h:25,
from doxygenplugin.cpp:21:
doxygensettingswidget.h:25:36: error: libs/utils/pathchooser.h: No such file or directory
doxygenplugin.cpp:25:50: error: plugins/cppeditor/cppeditorconstants.h: No such file or directory
doxygenplugin.cpp:26:48: error: plugins/cpptools/cpptoolsconstants.h: No such file or directory
doxygenplugin.cpp:28:38: error: plugins/coreplugin/icore.h: No such file or directory
doxygenplugin.cpp:29:46: error: plugins/coreplugin/coreconstants.h: No such file or directory
doxygenplugin.cpp:30:60: error: plugins/coreplugin/actionmanager/actionmanager.h: No such file or directory
doxygenplugin.cpp:31:54: error: plugins/coreplugin/actionmanager/command.h: No such file or directory
doxygenplugin.cpp:32:48: error: plugins/coreplugin/uniqueidmanager.h: No such file or directory
doxygenplugin.cpp:33:54: error: plugins/coreplugin/editormanager/ieditor.h: No such file or directory
doxygenplugin.cpp:34:60: error: plugins/coreplugin/editormanager/editormanager.h: No such file or directory
doxygenplugin.cpp:36:47: error: plugins/coreplugin/messagemanager.h: No such file or directory
doxygenplugin.cpp:37:45: error: plugins/projectexplorer/project.h: No such file or directory
doxygenplugin.cpp:38:53: error: plugins/projectexplorer/projectexplorer.h: No such file or directory
doxygenplugin.cpp:39:45: error: plugins/projectexplorer/session.h: No such file or directory
doxygenplugin.cpp:40:62: error: plugins/projectexplorer/projectexplorerconstants.h: No such file or directory
doxygenplugin.cpp:41:50: error: plugins/projectexplorer/outputwindow.h: No such file or directory
doxygenplugin.cpp:42:34: error: libs/utils/qtcassert.h: No such file or directory
doxygenplugin.cpp:43:43: error: libs/utils/synchronousprocess.h: No such file or directory
doxygenplugin.cpp:44:40: error: libs/utils/parameteraction.h: No such file or directory
doxygenplugin.cpp:45:48: error: libs/extensionsystem/pluginmanager.h: No such file or directory
In file included from doxygenplugin.cpp:21:
doxygenplugin.h:41: error: 'ExtensionSystem' has not been declared
doxygenplugin.h:41: error: expected `{' before 'IPlugin'
doxygenplugin.h:41: error: function definition does not declare parameters
doxygenplugin.cpp:53: error: 'ExtensionSystem' is not a namespace-name
doxygenplugin.cpp:53: error: expected namespace-name before ';' token
doxygenplugin.cpp:65: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:67: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:71: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:75: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:123: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:127: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:131: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:137: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:142: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:209: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:214: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp:221: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.cpp: In function 'QObject* qt_plugin_instance()':
doxygenplugin.cpp:285: error: invalid use of incomplete type 'class DoxyPlugin::Internal::DoxygenPlugin'
doxygenplugin.h:41: error: forward declaration of 'class DoxyPlugin::Internal::DoxygenPlugin'
lipo: can't open input file: /var/folders/Iq/Iq71hPvdHWqnhILFktPYR++++TI/-Tmp-//cc4sE6r3.out (No such file or directory)
make: *** [.obj/debug-shared/doxygenplugin.o] Error 1
make: Leaving directory `/Users/macko_j/Projets/qt-creator-1.3.1-src/src/plugins/doxygen'
Terminé avec le code de sortie 2.
Erreur lors de la compilation du projet doxygen
lors de l'éxecution de l'étape 'Make'

Il ne trouve pas certain headers j'ai fouiller mon ordi avec un locate (avec un index a jour biensur) et je n'ai rien trouver non plus.

Est tu sur que je n'ai rien oublier dans le mod op d'installation.

Je repete les operation que j'ai effectuer :
- J'ai recuperer les sources du plugins doxygen
- J'ai recuperer les sources de QT Creator
- Je l'ai compiler
- J'ai deplacer ton plugin dans le dossier plugin g fait un qmake -projet & qmake puis j'ai mis a jour le fichier .pro pour qu'il ressemble a sa

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
25
26
27
# #####################################################################
# Automatically generated by qmake (2.01a) mar. fvr. 23 14:11:49 2010
# #####################################################################
DEPENDPATH += .
INCLUDEPATH += .
 
# Input
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 \
    Doxygen_dependencies.pri
DEFINES += DOXYGEN_LIBRARY

Mais rien n'y fait j'ai toujours un max de problème pour compiler.

24/02/2010, 01h47
gbdivers

J'avais oublié ça aussi...

Alors, pas d'inquiétude, si tu as réussit à compiler Qt Creator, c'est que tous les fichiers sont présents.
Tu les trouveras dans $QTDIR/src/plugins/

Une petite remarque : qmake utilise le fichier pro. Donc si tu le modifies, il faut le faire avant qmake :)

Pour l'explication du problème : dans le configuration d'origine, les fichiers sont inclues à partir de $QTDIR/src/. Tous les fichiers sont dont référencés en fonction de ce chemin. Par exemple, le fichier doxygenplugin.h include le fichier iplugin.h par :

Code:

#include <lib/extensionsystem/iplugin.h>

Le problème est, si j'ai bien compris les sources de doxygen, c'est que la configuration pour mac n'est pas prévue.

La solution que je te donnais, la configuration par défaut des plugins QtCreator, est de mettre les sources dans $QTDIR/src/plugins/doxygen/
Les fichiers inclues seront référencés par :

Code:

#include <extensionsystem/iplugin.h>

Donc, 2 solutions : soit tu pars des fichiers d'origine et tu modifies le fichier pro pour inclure la prise en charge des mac. Soit tu modifies les sources pour corriger les #include puis tu recompiles.

Ca peut paraître compliqué au premier abord mais tu verras que c'est pas trop compliqué au final.
02/03/2010, 04h03
mak972

Sa ne fonctionne toujours pas peut être que je suis un âne :ccool: mais sa ne fonctionne pas donc pour le coup je vais tout reprendre a 0 et vous faire un retour rapidement.

Après avoir regardé plus en détail, je pense qu'il est possible de simplement ajouter les options de compilation pour mac dans le projet :

Fichier d'origine :

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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
TEMPLATE = lib
TARGET = Doxygen
DEFINES += DOXYGEN_LIBRARY
PROVIDER = Kofee
 
# 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/
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/
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
include( $$IDE_SOURCE_TREE/src/qtcreatorplugin.pri )
include( $$IDE_SOURCE_TREE/src/plugins/coreplugin/coreplugin.pri )
include( $$IDE_SOURCE_TREE/src/plugins/texteditor/texteditor.pri )
include( $$IDE_SOURCE_TREE/src/plugins/cppeditor/cppeditor.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
INCLUDEPATH += $$QTC_SOURCE_DIR/src \
    $$QTC_SOURCE_DIR/src/plugins \
    $$QTC_SOURCE_DIR/src/libs \
    $$QTC_SOURCE_DIR/src/libs/cplusplus \
    $$QTC_SOURCE_DIR/src/libs/extensionsystem \
    $$QTC_SOURCE_DIR/src/libs/utils \
    $$QTC_SOURCE_DIR/src/shared \
    $$QTC_SOURCE_DIR/src/shared/cplusplus
 
message(QTC_SOURCE_DIR = $$QTC_SOURCE_DIR)
message(IDE_SOURCE_TREE = $$IDE_SOURCE_TREE)
message(QTC_BUILD_DIR = $$QTC_BUILD_DIR)
message(IDE_BUILD_TREE = $$IDE_BUILD_TREE)
message(DESTDIR = $$DESTDIR)
message(Good luck with make... :-D)

Modifications :

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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
TEMPLATE = lib
TARGET = Doxygen
DEFINES += DOXYGEN_LIBRARY
PROVIDER = Kofee

# 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/
macx:QTC_SOURCE_DIR = (ton répertoire vers les sources de qt creator)
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/
macx:QTC_BUILD_DIR = (ton répertoire vers les sources de QDoxygen)
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) (la définition de DESTDIR est modifiée durant le compilation et n'est pas prise en compte)
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
macx:LIBS += -L (3 liens à ajouter : vers les libs de Qt, vers les libs de Qt Creator et vers les plugins de Qt Creator)
include( $$IDE_SOURCE_TREE/src/qtcreatorplugin.pri )
include( $$IDE_SOURCE_TREE/src/plugins/coreplugin/coreplugin.pri )
include( $$IDE_SOURCE_TREE/src/plugins/texteditor/texteditor.pri )
include( $$IDE_SOURCE_TREE/src/plugins/cppeditor/cppeditor.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
INCLUDEPATH += $$QTC_SOURCE_DIR/src \
    $$QTC_SOURCE_DIR/src/plugins \
    $$QTC_SOURCE_DIR/src/libs \
    $$QTC_SOURCE_DIR/src/libs/cplusplus \
    $$QTC_SOURCE_DIR/src/libs/extensionsystem \
    $$QTC_SOURCE_DIR/src/libs/utils \
    $$QTC_SOURCE_DIR/src/shared \
    $$QTC_SOURCE_DIR/src/shared/cplusplus

message(QTC_SOURCE_DIR = $$QTC_SOURCE_DIR)
message(IDE_SOURCE_TREE = $$IDE_SOURCE_TREE)
message(QTC_BUILD_DIR = $$QTC_BUILD_DIR)
message(IDE_BUILD_TREE = $$IDE_BUILD_TREE)
message(DESTDIR = $$DESTDIR)
message(Good luck with make... :-D)

La libs sera compilé dans $$SOURCE_DIR/lib/qtcreator/plugins/Kofee/. Tu dois copier les 2 fichiers présents (libDoxygen.* et DOxygen.pluginspec) dans le repertoire des plugins de Qt Creator.

En fonction de la version de Qt Creator que tu utilises, tu devras peut être modifier DOxygen.pluginspec (et peut être les sources de QOxygen.cpp comme je l'ai indiqué dans un message précédant)

Ca devrait être plus simple

17/04/2010, 05h56
kofee

Oups, j'ai raté pas mal de choses ici depuis un moment...

@gbdivers : je n'ai pas trop eu le temps de regarder Qt 4.7 et Qt Creator 2 mais merci pour avoir déffriché tout ça. Merci également pour le déffrichage Mac, j'aimerais le faire mais je n'ai pas de Mac à disposition donc...
J'espère ne pas tarder à pouvoir me remettre dedans et déjà finir les fonctionnalités de base (avant d'ajouter d'autres choses si le temps le permet)

@mak972 : as tu finalement réussi à compiler la bestiole sous Mac ? Si oui ça pourrait être intéressant de me faire parvenir la bibliothèque binaire :)

Edit: commit r21 pour la technical preview (1.3.81) et qt style :)
Edit2: et binaires pour x86 et x86_64
06/04/2011, 23h55
kofee

Le fil est enterré mais en tout cas, la configuration pour Mac est maintenant prévue et je fournis également des binaires universels :)

cf page wiki (en) et page de téléchargement de binaires

k
26/04/2011, 11h47
K2R Nolween

Je ne sais pas si c'est pris en compte dans la version pour QtCreator 2.1.0, mais pour la version 2.0.1, j'ai ajouter la possibilité d'avoir le code doxygen avec les commentaires en mode en ligne ( "///" ) en plus. De plus au lieu de d'utiliser des test plusieurs fois pour savoir si un texte est dans l'éditeur, il faudrait mieux griser l'option dans le menu. Je me demande aussi si dans généré toute la doc il n'y aurait pas moyen de sauter les identifiant déjà documenté.
01/06/2011, 02h51
kofee

Bonsoir K2R Nolween,

Oui, te deux premières remarques ont été implantées pour 2.1.0 et 2.2.0 (même si pas de binaires encore pour cette dernière).

En revanche pour ne pas re-documenter des méthodes/déclarations qui l'ont déjà été ce n'est pas encore fait et ça devrait être si tout se passe bien ma contribution de l'été outre la maintenance et l'éradication d'un bug rare (mais présent) de templates.

++k

(je conseil le mail direct ou l'ouverture de bug tout de même, je ne reçois pas les notifications ici (d'où le lag) et c'est pénible :/)
01/06/2011, 11h04
gbdivers

Bonjour kofee

Je me posais une question suite à la sortie de Qt Creator 2 et à l'ajout des snippets, Qt Creator permet maintenant d'ajouter facilement le code pour la doc doxygen.
Penses-tu continuer à maintenir ton plugin ? Et si oui, quels fonctionnalités supplémentaires apporte-il par rapport aux snippets ?
04/06/2011, 18h10
kofee

Bonjour gbdivers,

Oui je le maintiens puisqu'il y a toujours une demande (je viens tout juste de sortir la maintenance pour 2.2.0). Ce qui est drôle c'est qu'en ce moment je ne fais que très peu de C/C++ et donc ce n'est pas pour moi que je le fais.
Comme fonctionnalités en plus il pourrait y en avoir pléthore mais un exemple que je viens d'ajouter est la documentation de tout un projet d'un coup.

Pour te répondre sur ce que ça apporte de plus par rapport aux snippets dans qtcreator, il faudrait que je me sois penché dessus ce qui n'est pas le cas :)
16/03/2012, 16h36
kouillo

Salut !

Ton plug-in m'interesse fortement, cependant je viens de passer à la dernière version du SDK, soit Qt Creator 2.4.1.

Pour faire passer ton plug-in j'ai modifié (à la bourrin) les compatibilités dans le fichier pluginspec, mais je ne suis pas sur que tout fonctionne correctement.

Si jamais tu peux republier les binaires pour la 2.4.1 ca serait cool :ccool:
Merci !

Edit : je viens de voir que dans les aides tu indiquais de renommer en 2.3.1 pour cette version, donc je suppose que ça doit rouler ainsi aussi pour la 2.4.1, donc si tu confirmes, pas besoin de binaire pour ça !
17/03/2012, 01h31
Troudhyl

Je l'utilise de cette façon (modification de pluginspec) depuis la sortie de Qt Creator 2.4.1, je ne sais pas pour toi mais en ce qui me concerne, le peu de fonctionnalités que j'utilise marche.
01/06/2012, 08h58
kofee

Salut,

@kouillo : Je confirme (après la guerre) la compatibilité binaire entre les versions "release" ou "micro" (i.e. x.y.Z) de qtcreator alors que ça brise systèmatiquement entre versions mineurs (et a fortiori majeurs). Donc je ne prends pas la peine de repacker des binaires puisque le code est inchangé, tout comme le binaire produit (eh !) mais il y a une mise à jour du pluginspec à faire à cause du chargeur de plugin qui est un peu "têteux".

Je viens de m'acheter un cerveau et découvrir comment mettre les notifications instantannées... avec un peu de chance je ne serai plus aussi en retard dans le futur au besoin.

k