Академический Документы
Профессиональный Документы
Культура Документы
http://dev.kofee.org/projects/qtcreator-doxygen/wiki
Welcome
You are welcome to contribute to the wiki if you register/use openid login.
Welcome Quick install with binaries Usage Output example Compilation from sources Get the source
svn download http download
For Linux and Windows, extract in $path_to_qtcreator$/lib/qtcreator/plugins/ and you should be good to go. For Mac OS X, extract in e.g. /Applications/Qt Creator.app/Contents/PlugIns/
Compile Against Nokia binaries (Linux) Against Nokia binaries (Mac OS X) Against a Gentoo install (qt-creator-2.1.0 here) Thanks
Usage
Generate Doxygen tags: CTRL+SHIFT+F3 and the context menu -> "Create Doxygen Documentation" Generate Doxygen tags for a whole file: CTRL+SHIFT+F5 and the context menu -> "Document whole file" Building project documentation: CTRL+SHIFT+F4 and the "Tools/Doxygen" menu -> "Build Doxygen Documentation". If you didn't create and configure a Doxyfile at your project root, the default one will be generated and used. Edit Doxyfile with doxywizard: CTRL+SHIFT+F6 Don't forget to configure the "doxygen" and "doxywizard" commands in "Settings/Documentation/Doxygen Plugin" if it is not in your $PATH.
Output example
Consider this meaningless snippet of code: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 typedef bool ILoveToPolluteTheMainNamespace; enum { bob, mark, louis }; class Hello { public: Hello(Feeling &iloveyou, bool wontyou, QList<Sentences> tellme, Person *your, const QString &name); bool initialize(const QStringList &arguments, QString *error_message); bool needSomething(QList<Something> &things); virtual void bye() = 0; QMap<QString, QList> randomMethod() const; //... };
That would become: 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 /*! \brief */ typedef bool ILoveToPolluteTheMainNamespace; /*! \brief */ enum { bob, mark, louis }; /*! \brief */ class Hello { public: /*! \brief \param iloveyou \param wontyou \param tellme \param your \param name */ Hello(Feeling &iloveyou, bool wontyou, QList<Sentences> tellme, Person *your, const QString &name);
1 of 3
04/12/2011 10:43 PM
http://dev.kofee.org/projects/qtcreator-doxygen/wiki
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 };
/*! \brief \param arguments \param error_message \return bool */ bool initialize(const QStringList &arguments, QString *error_message); /*! \brief \param things \return bool */ bool needSomething(QList<Something> &things); /*! \brief */ virtual void bye() = 0; /*! \brief \return QMap<QString, QList> */ QMap<QString, QList> randomMethod() const; //...
For a more visual feel about the plugin's work, see Screenshots.
svn download
The repository is world readable so it should be pretty straightforward, for downloading trunk from the command line: user@host $ svn co http://svn.kofee.org/svn/qtcreator-doxygen/trunk qtcreator-doxygen
And to get a specific revision use the @rev_number syntax, e.g. for the source for qtcreator-2.0.1: user@host $ svn co http://svn.kofee.org/svn/qtcreator-doxygen/trunk@32 qtcreator-doxygen
http download
If you want latest source: grab an archive of the trunk If you want a specific revision, then either select it manually on for qtcreator-2.0.1: websvn or append &rev=$rev_number to the download link, e.g. for the source
http://svn.kofee.org/dl.php?repname=QtCreator-Doxygen&path=%2Ftrunk%2F&isdir=1&rev=32
Compile
Once in the source directory, you have two choices: Edit the pro file to tweak it to your platform (paths, libs) Pass arguments to qmake (revision r34 and up): QTC_SOURCE_DIR: The directory containing qtcreator source code QTC_BUILD_DIR: The directory where we build the plugin LIBSROOT: The root of the built qtcreator lib directory DEST: The directory where the shared library and the plugin spec files will be moved to Example passing arguments to qmake: user@host ~/qtcreator-doxygen $ qmake QTC_SOURCE_DIR=/home/kofee/Dev/Qt/qt-creator-2.1.0-src \ QTC_BUILD_DIR=/home/kofee/qtcdox_build \ LIBSROOT=/home/kofee/qtcreator-2.1.0/lib \ DEST=/home/kofee/qtcreator-2.1.0/lib/qtcreator/plugins/Kofee You should see: Project Project Project Project Project Project MESSAGE: MESSAGE: MESSAGE: MESSAGE: MESSAGE: MESSAGE: QTC_SOURCE_DIR = /home/kofee/Dev/Qt/qt-creator-2.1.0-src IDE_SOURCE_TREE = /home/kofee/Dev/Qt/qt-creator-2.1.0-src QTC_BUILD_DIR = /home/kofee/qtcdox_build IDE_BUILD_TREE = /home/kofee/qtcdox_build DESTDIR = /home/kofee/qtcreator-2.1.0/lib/qtcreator/plugins/Kofee Good luck with make... :-D
2 of 3
04/12/2011 10:43 PM
http://dev.kofee.org/projects/qtcreator-doxygen/wiki
user@host ~/qtcreator-doxygen $ make If all goes well, it should be installed and (re)starting qtcreator will be enough to use the plugin.
long prompt stuff $ install_name_tool -change QtCore.framework/Versions/4/QtCore @executable_path/../Frameworks/QtCore.framework/V long prompt stuff $ install_name_tool -change QtGui.framework/Versions/4/QtGui @executable_path/../Frameworks/QtGui.framework/Vers
ebuild /usr/portage/dev-util/qt-creator/qt-creator-2.1.0.ebuild unpack qmake QTC_SOURCE_DIR=/var/tmp/portage/dev-util/qt-creator-2.1.0/work/qt-creator-2.1.0-src/ LIBSROO make make clean ebuild /usr/portage/dev-util/qt-creator/qt-creator-2.1.0.ebuild clean
Restart qt-creator :)
Thanks
The Trolls indeed, and therefore Nokia. Nicolas Arnaud-Cormos got me started. VCreate Logic gave me some more info.
3 of 3
04/12/2011 10:43 PM