Skip to content

/ qtcreator-doxygen

forked from fpoussin/qtcreator-doxygen
Doxygen Plugin for Qt Creator
C++ QMake
  1. C++ 96.7%
  2. QMake 3.3%
Branch: master
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio

If nothing happens, download the GitHub extension for Visual Studio and try again.

Pull request Compare This branch is 5 commits ahead, 10 commits behind fpoussin:master.
@cristianadam
cristianadam Refactored GitHub Actions for easier usage 
- produces zip files for downloading
- Qt and Qt Creator versions are set in one place at the top
- doesn't download Qt Creator source files, since they are not needed
Latest commit 7669ab0 Dec 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows Refactored GitHub Actions for easier usage Dec 23, 2019
Doxygen.json.in Updating version Nov 5, 2018
INSTALL Starting clean. Dec 8, 2015
Jenkinsfile Added Jenkinsfile Mar 6, 2019
LICENSE Adding the LICENSE file, LGPL v2.1. Dec 1, 2009
README.md Fixed build status icon Aug 18, 2019
doxygen.cpp Cleaning pointers Nov 5, 2018
doxygen.h Fix includes and library pathes Dec 23, 2015
doxygen.png This commit quite honnestly deserves the version number change :) Mar 16, 2011
doxygen.pro
doxygen.qrc Updated code for qtc 2.0.1 Sep 11, 2010
doxygen_global.h
doxygenconstants.h Adding/Fixing old code. It compiles and runs. Needs more fixing. Dec 9, 2015
doxygenfilesdialog.cpp Cleaning pointers Nov 5, 2018
doxygenfilesdialog.h change "document current project" menu selection from list widget to … Apr 10, 2017
doxygenfilesdialog.ui change "document current project" menu selection from list widget to … Apr 10, 2017
doxygenplugin.cpp
doxygenplugin.h Moving QProcess to pointer. Jan 5, 2016
doxygensettings.cpp Cleaning pointers Nov 5, 2018
doxygensettings.h Really fix the options dialog crasher Dec 23, 2015
doxygensettingsstruct.cpp Changes (file tree explorer, cleaning) for 4.3.x May 30, 2017
doxygensettingsstruct.h Removed thread, keeping signal/slots as it seems to be enough for flu… Dec 23, 2015
doxygensettingswidget.cpp Changes (file tree explorer, cleaning) for 4.3.x May 30, 2017
doxygensettingswidget.h Fix includes and library pathes Dec 23, 2015
doxygensettingswidget.ui Adding some of the original code for settings UI. Dec 9, 2015

README.md

qtcreator-doxygen

Doxygen Plugin for Qt Creator

GitHub version Build Status

This project is a fork of the original plugins at: http://dev.kofee.org/projects/qtcreator-doxygen
Built for the latest Qt-Creator versions.

It adds some features such as a file selection dialog for projects, and duplicate blocks detection.

Binaries are available in the releases section.
https://github.com/fpoussin/qtcreator-doxygen/releases

Compiling

You will have to install the same Qt version (ie: 5.10 MSVC 2015 32 bit for 4.5.0) that was used to build the Qt creator version you are targeting for the plugin.
You can check this in the "about" menu of Qt creator.

  • Download and extract the Qt creator sources from the official website
  • Compile them using the correct Qt kit (Optional on linux, you can point to the official binary release which should be in your home folder by default)
  • You don't need to install it when compiled
To compile the plugin you have 2 options:

Qmake

  • Specify the path of source and binaries for Qt creator using QTC_SOURCE and QTC_BUILD vars
  • QTC_SOURCE must point to the sources you extracted
  • QTC_BUILD must point to your build folder (or binary release on Linux)
  • Example command: qmake QTC_SOURCE=~/src/qt-creator-opensource-src-4.5.0 QTC_BUILD=~/qtcreator-4.5.0 .

Qt Creator

  • Specify the path of source and binaries for Qt creator by editing the dexygen.pro file
  • You have to change the QTCREATOR_SOURCES and IDE_BUILD_TREE vars

Installing

If you compiled the plugin, it will be installed automatically.

If you downloaded a binary release, the paths are as follow:
  • Unix: ~/.local/share/data/QtProject/qtcreator/plugins/<version>
  • OSX: ~/Library/Application Support/QtProject/Qt Creator/plugins/<version>
  • Windows: %LOCALAPPDATA%\QtProject\qtcreator\plugins\<version>
    Replace <version> with your Qt Creator version (ie: 4.8.0)
You can’t perform that action at this time.