https://github.com/fpoussin/qtcreator-doxygen

Doxygen Plugin for Qt Creator
https://github.com/fpoussin/qtcreator-doxygen

doxygen doxygen-plugin qt qtcreator

Last synced: about 1 year ago
JSON representation

Doxygen Plugin for Qt Creator

• Host: GitHub
• URL: https://github.com/fpoussin/qtcreator-doxygen
• Owner: fpoussin
• License: lgpl-2.1
• Created: 2015-12-08T16:02:22.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2021-02-02T13:02:33.000Z (over 5 years ago)
• Last Synced: 2025-05-08T16:59:58.525Z (about 1 year ago)
• Topics: doxygen, doxygen-plugin, qt, qtcreator
• Language: C++
• Homepage:
• Size: 169 KB
• Stars: 194
• Watchers: 13
• Forks: 71
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# qtcreator-doxygen

Doxygen Plugin for Qt Creator

[![GitHub version](https://badge.fury.io/gh/fpoussin%2Fqtcreator-doxygen.svg)](https://github.com/fpoussin/qtcreator-doxygen/releases)

[![Build Status](https://jenkins.netyxia.net/buildStatus/icon?job=qtcreator-doxygen%2Fmaster)](https://jenkins.netyxia.net/job/qtcreator-doxygen/job/master/)  

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)  

* **USE_USER_DESTDIR** installs the module automatically  

* Example command: *qmake USE_USER_DESTDIR=yes 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/**\**  

* OSX: ~/Library/Application Support/QtProject/Qt Creator/plugins/**\**  

* Windows: %LOCALAPPDATA%\QtProject\qtcreator\plugins\\**\**  

Replace **\**  with your Qt Creator version (ie: 4.8.0)