If one entity in the file is documented, the next one appearing in the code cannot be documented with use of "Document current entity" function.

I have an error when I try to install the plugin.

Have a look at https://www.qt.io/blog/building-qt-creator-plugins-with-github-actions where I described how you can use GitHub Actions to build a Qt Creator plugin for Linux, mac, and Windows.

no Doxygen-0.4.7-qtc4.13.x-win32.dll，Can you add to it？thanks。

Hi,
Qt Creator 4.5 is out. Could you compile the related binaries?
Thanks a lot for this plugin!

Qt-Creator was updated to version 4.3.0.

Compile error:
/tmp/qtcreator-doxygen/doxygenplugin.cpp:334: error: no match for 'operator=' (operand types are 'QString' and 'QByteArray') response.stdErr = m_process->readAllStandardError();

Running on Ubuntu 14.04 with following parms:
QTCREATOR_SOURCES =/tmp/qt-creator
IDE_BUILD_TREE =/tmp/buildqtc
IDE_LIBRARY_BASENAME = /opt/Qt5.6.1/Tools/QtCreator/lib

/tmp/qt-creator: version 4.01

I tried to maintain this package on aur. I get following error with headers:

doxygen.h:25:10: fatal error: 3rdparty/cplusplus/Symbols.h: No such file or directory
 #include <3rdparty/cplusplus/Symbols.h>
          ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.
make: *** [Makefile:993: doxygen.o] Error 1
make: *** Waiting for unfinished jobs....
In file included from doxygensettings.h:25,
                 from doxygensettings.cpp:22:
/usr/src/qtcreator/src/plugins/coreplugin/dialogs/ioptionspage.h:30:10: fatal error: utils/icon.h: No such file or directory
 #include <utils/icon.h>
          ^~~~~~~~~~~~~~
compilation terminated.
make: *** [Makefile:932: doxygensettings.o] Error 1
In file included from doxygenplugin.cpp:22:
doxygenplugin.h:29:10: fatal error: extensionsystem/iplugin.h: No such file or directory
 #include <extensionsystem/iplugin.h>
          ^~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.
make: *** [Makefile:910: doxygenplugin.o] Error 1
In file included from doxygensettingswidget.cpp:22:
doxygensettingswidget.h:26:10: fatal error: utils/pathchooser.h: No such file or directory
 #include <utils/pathchooser.h>
          ^~~~~~~~~~~~~~~~~~~~~
compilation terminated.
make: *** [Makefile:939: doxygensettingswidget.o] Error 1
In file included from moc_doxygensettingswidget.cpp:9:
doxygensettingswidget.h:26:10: fatal error: utils/pathchooser.h: No such file or directory
 #include <utils/pathchooser.h>
          ^~~~~~~~~~~~~~~~~~~~~
compilation terminated.
make: *** [Makefile:1010: moc_doxygensettingswidget.o] Error 1
In file included from doxygenfilesdialog.h:7,
                 from doxygenfilesdialog.cpp:1:
/usr/src/qtcreator/src/plugins/projectexplorer/projectnodes.h:34:10: fatal error: utils/fileutils.h: No such file or directory
 #include <utils/fileutils.h>
          ^~~~~~~~~~~~~~~~~~~
compilation terminated.
make: *** [Makefile:998: doxygenfilesdialog.o] Error 1
==> ERROR: A failure occurred in build().
    Aborting...

What path to include to pass this?

rc.customShortDocEnd = QString(ui->edit_shortTagEnd->text()).replace("\\\n", "\n");

should be

rc.customShortDocEnd = QString(ui->edit_shortTagEnd->text()).replace("\\n", "\n");

This plugin has been removed from all Arch based Linux distros. I use Manjaro but qtcreator comes from Arch repos.
Since me and my team at work love using doxygen, I would like to see this plugin updated to work with qtcreator 6+.

I see this is a team of 5 developers but this repo hasn't been updated in 12 months. I would like to know if this team is still interested and has time to maintain this plugin. If not, then I would like to look into this issue and see if I can help.

I want to compile my code with Compile: qmake && make.

https://github.com/PradeepSimba/test/blob/main/.github/workflows/main.yml

But , If I run it comes an error .

https://github.com/PradeepSimba/test/runs/6637488143?check_suite_focus=true#step:7:59

How can I solve this error ?

Would it be possible to add additional author & date tags to function headers by default?
/**
* @brief ...
*
* @param ...
* @return ...
*
* @author ...
* @date ...
*/
Also, to have them auto-populated based on username/current date or predefined values would be a nice feature.

Hi @fpoussin ,

I upgraded from QtCreator 4.13 to 4.14 (64-bit Linux) and now the Doxygen plugin is no longer working.

Please check it and find below the error messages from Qt Creator.

Could not resolve dependency 'Core(4.13.2)'
Could not resolve dependency 'CppTools(4.13.2)'
Could not resolve dependency 'CppEditor(4.13.2)'
Could not resolve dependency 'ProjectExplorer(4.13.2)'
Could not resolve dependency 'TextEditor(4.13.2)'

Cannot include coreplugin. Not found.

I download the last code, when compiling the fllow error report:
/run/media/root/disk2/download/doxygen_new/qtcreator-doxygen/doxygensettingswidget.cpp:23: error: ui_doxygensettingswidget.h: No such file or directory
#include "ui_doxygensettingswidget.h"
^

hi @fpoussin ,

I try build the source code from QTC v4.7.2, but generate libDoxygen.so is not show on about plugin dialog.
Can you tell me how to fix it?

I am using mac, and I cannot compile the binary from the source code, could u also provide us with the binary code for mac, I will appreciated! Meanwhile, could u elaborate the details about how to compile from the source code in Readme file. thanks again !

This is really a nice tool !

Release 0.4.6 is supporting QTC 4.3-4.6
Release 0.4.7 is supporting QTC 4.10-4.12

What is the reason why there is no release for QTC 4.7.x, 4.8.x and 4.9.x ?

Thank you for your answer！

This would allow the user to add doxygen tags to parts of a file in one go.

I foresee heavy use of such feature in the context of files where a few symbols need documentation but not quite all of them, or to specifically avoid a few symbols. A typical example would be commenting all the entries of an enum (and even better, align the short doc strings but that is for another issue).

May you please release binaries for Qt Creator 4.12.4

I tried to build it by myself by I failed to build it correctly although I set a valid values to IDE_BUILD_TREE and QTCREATOR_SOURCES

Hi

Please compile a windows version for the latest release.

Thanks in advance.

Best,
David

Hello, I couldn't compile source and I'm afraid to corrupt the ROS support for qtcreator. Can you please provide binary for linux qtcreator 4.9.x. Thank you

I've added the binary to AppData\Local\QtProject\QtCreator\plugins\ but no new plugins appeared in the plugins section of the qtcreator

Qt Creator was updated to 4.1.0.

Maybe should have a funcation add some infomation in some file head, like this:
/********************************************************************

• Copyright (c) 2013 XXXXXXXXX.inc
• All rights reserved.
• \file test.cpp
• \brief implement functions
• \version 1.0
• \author xxx
• \Email [email protected]
• \date 2013-10-11 (auto gen)

*/

Right now rebuilding the docs freezes QtCreator because of the use of a Synchronous process. As it takes several minutes to rebuild the doc this is unbearable for me. (I use the new-ish CLANG_ASSISTED_PARSING = YES option, which does not help at all).

I compiled it on archlinux and updated my aur package. You may want to add it to releases page.

libDoxygen.zip

Hi,
I installed QtCreator v4.12 2 weeks ago. I noticed that the Doxygen plugin no longer worked. I checked your binary releases but there is none for QtCreator v4.12.
I managed to build a working Doxygen4.dll that works in QtCreator v4.12
If you're interested, I can send it to you...

Tom

I'm using Qt Creator IDE 4.9.2 and I downloaded the binary *.dll plugin for Windows 10 x64 and put it on the plugins folder, but when Qt starts, I got this error message:

The following plugins have errors and cannot be loaded:
Doxygen

Details:
Could not resolve dependency 'Core(4.7.2)'
Could not resolve dependency 'CppTools(4.7.2)'
Could not resolve dependency 'CppEditor(4.7.2)'
Could not resolve dependency 'ProjectExplorer(4.7.2)'
Could not resolve dependency 'TextEditor(4.7.2)'

What I have to do?

I use mingw 64 with qt 5.12.2 and QtCreator 4.8.2
Am I able to use this plugin with this configuration?

I don't know if the long-term goal is to get this plugin upstream, but it might be a good idea to conform to the official coding style.

I guess running a beautifier against the current code could help a lot.

I'm not sure what the problem is here, maybe I'm using an old version of qmake or something.
When I try to run qmake it is not able to assign QTC_SOURCE to QTCREATOR_SOURCES or IDE_BUILD_TREE to QTC_BUILD. I had to make the following change to get it working:

diff --git a/doxygen.pro b/doxygen.pro
index f2af220..3edd2bc 100644
--- a/doxygen.pro
+++ b/doxygen.pro
@@ -27,12 +27,12 @@ RESOURCES += doxygen.qrc
 # Qt Creator linking
 
 ## set the QTC_SOURCE environment variable to override the setting here
-QTCREATOR_SOURCES = $$(QTC_SOURCE)
+QTCREATOR_SOURCES = $$QTC_SOURCE
 unix:isEmpty(QTCREATOR_SOURCES):QTCREATOR_SOURCES=$$(HOME)/src/qt-creator-opensource-src-4.3.0
 win32:isEmpty(QTCREATOR_SOURCES):QTCREATOR_SOURCES=D:\src\qt-creator-opensource-src-4.3.0
 
 ## set the QTC_BUILD environment variable to override the setting here
-IDE_BUILD_TREE = $$(QTC_BUILD)
+IDE_BUILD_TREE = $$QTC_BUILD
 unix:isEmpty(IDE_BUILD_TREE):IDE_BUILD_TREE=$$(HOME)/qtcreator-4.3.0
 win32:isEmpty(IDE_BUILD_TREE):IDE_BUILD_TREE=D:\src\build-qtcreator-5_6_0_msvc2013-Release

Qmake command:

$ qmake --version
QMake version 3.1
Using Qt version 5.9.2 in /home/sjuul/Qt/5.9.2/gcc_64/lib

$ ~/Qt/5.9.2/gcc_64/bin/qmake QTC_SOURCE=~/tools/qt-creator-opensource-src-4.5.0/ QTC_BUILD=~/Qt/Tools/QtCreator/ .

Precompiled version of QtCreator 4.01 is build with GLIBCXX_3.4

$ strings /opt/Qt5.6.1/Tools/QtCreator/bin/qtcreator | grep GLIB
GLIBC_2.2.5
GLIBCXX_3.4

Precompiled version of this plugin is build with GLIBCXX_3.4.21

$ strings libDoxygen-0.4.3-qtc4.0.x-x86_64.so | grep GLIB
GLIBC_2.14
GLIBC_2.2.5
GLIBC_2.4
GLIBCXX_3.4.21
GLIBCXX_3.4
__stack_chk_fail@@GLIBC_2.4
strlen@@GLIBC_2.2.5
_ZdlPv@@GLIBCXX_3.4
_ZNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEE9_M_createERmm@@GLIBCXX_3.4.21
__cxa_atexit@@GLIBC_2.2.5
_ZSt19__throw_logic_errorPKc@@GLIBCXX_3.4
memcpy@@GLIBC_2.14
_Znwm@@GLIBCXX_3.4
__cxa_finalize@@GLIBC_2.2.5
strcmp@@GLIBC_2.2.5

Resulting in:

 $ ldd libDoxygen-0.4.3-qtc4.0.x-x86_64.so                                                        
./libDoxygen-0.4.3-qtc4.0.x-x86_64.so: /usr/lib/x86_64-linux-gnu/libstdc++.so.6: version `GLIBCXX_3.4.21' not found (required by ./libDoxygen-0.4.3-qtc4.0.x-x86_64.so)

on an Ubuntu 14.04 due to the package version

$ ldd --version
ldd (Ubuntu EGLIBC 2.19-0ubuntu6.9) 2.19

The release page states support for 4.0-rc, but it doesn't work with Qt Creator 4.0.0 Snapshot 417:

The following plugins have errors and cannot be loaded:
  Doxygen

Details:
  Could not resolve dependency 'Core(3.6.0)'
  Could not resolve dependency 'CppTools(3.6.0)'
  Could not resolve dependency 'CppEditor(3.6.0)'
  Could not resolve dependency 'ProjectExplorer(3.6.0)'
  Could not resolve dependency 'TextEditor(3.6.0)'