recent build/use of Doxygen plugin?
-
wrote on 25 Sept 2017, 14:58 last edited by
I'm trying to build the doxygen plugin mentioned in the Wiki. I'm getting a bunch of build errors that I just don't have time to chase down right now (I'll use doxygen standalone instead).
I was just curious if anyone had successfully built this plugin recently.
Thanks...
-
wrote on 25 Sept 2017, 15:00 last edited by
I am sorry to ask but what do you need this plugin for? I use commenting style from Doxygen wiki and it works just great? What do I miss?
-
wrote on 25 Sept 2017, 15:02 last edited by
I haven't used the plugin yet, but I was hopeful that it would automate some of the comment formatting for doxygen.
The plugin certainly isn't essential, but if it did what I thought it would do, it would be very convenient.
-
wrote on 25 Sept 2017, 15:03 last edited by
But QtCreator already does that to some extend?
-
Hi
Not sure what the plugin does.Creator can do tricks
( @artwaw beat me to it :)like ///(and press enter) class MainWindow : public QMainWindow { gives /// /// \brief The MainWindow class /// class MainWindow : public QMainWindow { and same with functions /// /// \brief PointSegmentDistanceSquared /// \param px /// \param py /// \param p1x /// \param p1y /// \param p2x /// \param p2y /// \param t /// \param qx /// \param qy /// \return /// double PointSegmentDistanceSquared( double px, double py, double p1x, double p1y, double p2x, double p2y, double& t, double& qx, double& qy) {
-
wrote on 25 Sept 2017, 15:08 last edited by
I don't get that behavior from Creator. Did you have to do something to enable it?
-
@mzimmers
Really?
I know only of these
-
wrote on 25 Sept 2017, 15:13 last edited by
I have that option enabled, but it doesn't seem to do anything. Are you using C++? And you just type "///" ? Do you select any code first?
-
I have that option enabled, but it doesn't seem to do anything. Are you using C++? And you just type "///" ? Do you select any code first?
I place cursor on line directly above class or function
i type /// (3 of them) and press enterand yes c++.
-
wrote on 25 Sept 2017, 15:18 last edited by
OK, I got it to work for me. So, is the /// \ a newer format than the /*! listed in the doxygen help?
-
OK, I got it to work for me. So, is the /// \ a newer format than the /*! listed in the doxygen help?
@mzimmers
Not really. it is just one way.
you can also use
/**(and enter) to get the other style.
/** * @brief MainWindow * @param parent */ explicit MainWindow(QWidget* parent = 0);
I assume there are even more :)
-
wrote on 25 Sept 2017, 15:29 last edited by
Yay! Thanks...and yes there are more, at least this one: /!* (which supposedly is the Qt form).
So, once you get this in, do you just run doxygen separately?
-
Yay! Thanks...and yes there are more, at least this one: /!* (which supposedly is the Qt form).
So, once you get this in, do you just run doxygen separately?
@mzimmers said in recent build/use of Doxygen plugin?:
So, once you get this in, do you just run doxygen separately?
Yes, i have .sh (bat) file to run it from the project folder.
I use a options file for it to specify settings. -
Yay! Thanks...and yes there are more, at least this one: /!* (which supposedly is the Qt form).
So, once you get this in, do you just run doxygen separately?
1/14