Unsolved Doxygen as "compiled plug-in" ?
-
I am not smart enough to "roll my own" as outlined here:
https://wiki.qt.io/Doxygen_Plugin_for_QtCreator
Is there a lazy man way to implement Doxygen in QtCreator?
I just loaded "menus" example and it seems to have "documentation marks" in source code. Like to utilize them , if that is what they are.
-
@AnneRanch
hi, If you are asking if it is possible to use doxygen with your qt project without compiling Qt Creator from source, then the answer is yes.
edit what i mean is you can comment you code with Doxygen syntax then generate documentation for your project without integrating Doxygen to QtCreator -
@LeLev said in Doxygen as "compiled plug-in" ?:
@AnneRanch
hi, If you are asking if it is possible to use doxygen with your qt project without compiling Qt Creator from source, then the answer is yes.Is there a lazy man way to implement Doxygen in QtCreator?
If so - can you tell me how ? -
Hi
the "lazy" way is simply to download doxygen
https://www.doxygen.nl/download.html
and then add comments to the code
then follow https://www.doxygen.nl/manual/starting.html
Its important to setup the config file properly.
Then doxygen can scan folders for files and generate the docs.The plugin is not a must use.
Do note that Creator has some tricks up its sleeve for tagging the code
-
this might interest you as well if you use QML
https://invent.kde.org/sdk/doxyqml -
I use daily what @mrjj presented. Also added complete run of doxygen to be build (so doxygen plus make and additional steps needed for me) with every release build. Required some setup (I simply wrapped it all up in the shell script and added as a final step) but was totally worth it.
