Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Users
  • Groups
  • Search
  • Get Qt Extensions
  • Unsolved
Collapse
Brand Logo
  1. Home
  2. Qt Development
  3. General and Desktop
  4. recent build/use of Doxygen plugin?
Forum Updated to NodeBB v4.3 + New Features

recent build/use of Doxygen plugin?

Scheduled Pinned Locked Moved Solved General and Desktop
14 Posts 3 Posters 2.5k Views 3 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • M Offline
    M Offline
    mzimmers
    wrote on 25 Sept 2017, 14:58 last edited by
    #1

    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...

    1 Reply Last reply
    0
    • A Offline
      A Offline
      artwaw
      wrote on 25 Sept 2017, 15:00 last edited by
      #2

      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?

      For more information please re-read.

      Kind Regards,
      Artur

      1 Reply Last reply
      1
      • M Offline
        M Offline
        mzimmers
        wrote on 25 Sept 2017, 15:02 last edited by
        #3

        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.

        1 Reply Last reply
        0
        • A Offline
          A Offline
          artwaw
          wrote on 25 Sept 2017, 15:03 last edited by
          #4

          But QtCreator already does that to some extend?

          For more information please re-read.

          Kind Regards,
          Artur

          1 Reply Last reply
          1
          • M Offline
            M Offline
            mrjj
            Lifetime Qt Champion
            wrote on 25 Sept 2017, 15:04 last edited by mrjj
            #5

            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) {
            
            
            1 Reply Last reply
            2
            • M Offline
              M Offline
              mzimmers
              wrote on 25 Sept 2017, 15:08 last edited by
              #6

              I don't get that behavior from Creator. Did you have to do something to enable it?

              M 1 Reply Last reply 25 Sept 2017, 15:09
              0
              • M mzimmers
                25 Sept 2017, 15:08

                I don't get that behavior from Creator. Did you have to do something to enable it?

                M Offline
                M Offline
                mrjj
                Lifetime Qt Champion
                wrote on 25 Sept 2017, 15:09 last edited by
                #7

                @mzimmers
                Really?
                I know only of these
                alt text

                1 Reply Last reply
                1
                • M Offline
                  M Offline
                  mzimmers
                  wrote on 25 Sept 2017, 15:13 last edited by
                  #8

                  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?

                  M 1 Reply Last reply 25 Sept 2017, 15:14
                  0
                  • M mzimmers
                    25 Sept 2017, 15:13

                    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?

                    M Offline
                    M Offline
                    mrjj
                    Lifetime Qt Champion
                    wrote on 25 Sept 2017, 15:14 last edited by mrjj
                    #9

                    @mzimmers

                    I place cursor on line directly above class or function
                    i type /// (3 of them) and press enter

                    and yes c++.

                    1 Reply Last reply
                    2
                    • M Offline
                      M Offline
                      mzimmers
                      wrote on 25 Sept 2017, 15:18 last edited by
                      #10

                      OK, I got it to work for me. So, is the /// \ a newer format than the /*! listed in the doxygen help?

                      M 1 Reply Last reply 25 Sept 2017, 15:25
                      0
                      • M mzimmers
                        25 Sept 2017, 15:18

                        OK, I got it to work for me. So, is the /// \ a newer format than the /*! listed in the doxygen help?

                        M Offline
                        M Offline
                        mrjj
                        Lifetime Qt Champion
                        wrote on 25 Sept 2017, 15:25 last edited by mrjj
                        #11

                        @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 :)

                        1 Reply Last reply
                        2
                        • M Offline
                          M Offline
                          mzimmers
                          wrote on 25 Sept 2017, 15:29 last edited by
                          #12

                          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?

                          M A 2 Replies Last reply 25 Sept 2017, 16:00
                          0
                          • M mzimmers
                            25 Sept 2017, 15:29

                            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?

                            M Offline
                            M Offline
                            mrjj
                            Lifetime Qt Champion
                            wrote on 25 Sept 2017, 16:00 last edited by mrjj
                            #13

                            @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.

                            1 Reply Last reply
                            0
                            • M mzimmers
                              25 Sept 2017, 15:29

                              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?

                              A Offline
                              A Offline
                              artwaw
                              wrote on 26 Sept 2017, 07:45 last edited by
                              #14

                              @mzimmers I can confirm that this also works on Windows. I use standalone Doxygen, with dot, dia and all the stack.

                              For more information please re-read.

                              Kind Regards,
                              Artur

                              1 Reply Last reply
                              1

                              1/14

                              25 Sept 2017, 14:58

                              • Login

                              • Login or register to search.
                              1 out of 14
                              • First post
                                1/14
                                Last post
                              0
                              • Categories
                              • Recent
                              • Tags
                              • Popular
                              • Users
                              • Groups
                              • Search
                              • Get Qt Extensions
                              • Unsolved