Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Users
  • Groups
  • Search
  • Get Qt Extensions
  • Unsolved
Collapse
Brand Logo
  1. Home
  2. Qt Development
  3. Qt Creator and other tools
  4. Doxygen as "compiled plug-in" ?
QtWS25 Last Chance

Doxygen as "compiled plug-in" ?

Scheduled Pinned Locked Moved Unsolved Qt Creator and other tools
6 Posts 4 Posters 453 Views
  • 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.
  • A Offline
    A Offline
    Anonymous_Banned275
    wrote on last edited by
    #1

    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.

    ODБOïO 1 Reply Last reply
    0
    • A Anonymous_Banned275

      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.

      ODБOïO Offline
      ODБOïO Offline
      ODБOï
      wrote on last edited by ODБOï
      #2

      @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

      A 1 Reply Last reply
      2
      • ODБOïO ODБOï

        @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

        A Offline
        A Offline
        Anonymous_Banned275
        wrote on last edited by
        #3

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

        1 Reply Last reply
        0
        • mrjjM Offline
          mrjjM Offline
          mrjj
          Lifetime Qt Champion
          wrote on last edited by mrjj
          #4

          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
          alt text

          1 Reply Last reply
          4
          • ODБOïO Offline
            ODБOïO Offline
            ODБOï
            wrote on last edited by
            #5

            this might interest you as well if you use QML
            https://invent.kde.org/sdk/doxyqml

            1 Reply Last reply
            1
            • artwawA Offline
              artwawA Offline
              artwaw
              wrote on last edited by
              #6

              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.

              For more information please re-read.

              Kind Regards,
              Artur

              1 Reply Last reply
              2

              • Login

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