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. QtCreator qch doxygen code tags
QtWS25 Last Chance

QtCreator qch doxygen code tags

Scheduled Pinned Locked Moved Unsolved Qt Creator and other tools
10 Posts 4 Posters 2.8k 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.
  • L Offline
    L Offline
    LuGRU
    wrote on last edited by
    #1

    Hello,
    I stumbled upon problem with doxygen tag \code that is inside source file.
    When generating HTML output I can see correctly example code, line by line correctly placed in HTML output), but when loading generated gch into QtCreator all example code is in one line without any indention, although I do see that code documentation style is applied but with x position of 0.
    Using \verbatim do resolve this, but varbatim is used for different purpose.

    Used version:
    QtCreator - 3.6.1
    doxygen - 1.8.11

    1 Reply Last reply
    0
    • SGaistS Offline
      SGaistS Offline
      SGaist
      Lifetime Qt Champion
      wrote on last edited by
      #2

      Hi,

      Can you show an sample comment code that triggers that ?

      Interested in AI ? www.idiap.ch
      Please read the Qt Code of Conduct - https://forum.qt.io/topic/113070/qt-code-of-conduct

      1 Reply Last reply
      0
      • L Offline
        L Offline
        LuGRU
        wrote on last edited by LuGRU
        #3

        Sorry for late reply.
        Here are screens from both HTML and QtCreator.

        HTML:

        https://i.imgsafe.org/a0731dd.jpg

        QtCreator:

        https://i.imgsafe.org/c7497eb.jpg

        Edit:
        I used custom config for doxygen, but with default one + enable QCH output in QtCreator is same.
        Seams like in QtC style for code is messed up.

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

          Can you test something ? Remove the * from the lines that are not the start nor stop of the comment block.

          Interested in AI ? www.idiap.ch
          Please read the Qt Code of Conduct - https://forum.qt.io/topic/113070/qt-code-of-conduct

          1 Reply Last reply
          0
          • L Offline
            L Offline
            LuGRU
            wrote on last edited by
            #5

            Same result, code is in one line.
            Tried removing * also from \code tags (and end) -also didn't helped.

            1 Reply Last reply
            0
            • Paul ColbyP Offline
              Paul ColbyP Offline
              Paul Colby
              wrote on last edited by
              #6

              The only thing that stands out to me is your use of \brief. That command is handled differently between QDoc and Doxygen - indeed, the wording of you comment suggests that you're expecting Doxygen's QT_AUTOBRIEF option to be enabled, yet the image you've attached suggests that option is not in affect (possibly because of your explicit \brief).

              Anyway, try either:

              • removing the \brief; and/or
              • adding a blank link between the \brief line, and the "more detailed description" line.

              It probably should work fine the way you have it, but give that a go anyway, just to see if that's the source of the issue.

              Cheers.

              1 Reply Last reply
              0
              • L Offline
                L Offline
                LuGRU
                wrote on last edited by
                #7

                Yes auto brief is enabled in config also.
                Tried above suggestion, result is same code is in one line.

                What I tried and didn't helped:

                • removal of \brief
                • removal of * at beginning of the line
                • putting comment in to /** ... / instead of /! ... */
                1 Reply Last reply
                0
                • SGaistS Offline
                  SGaistS Offline
                  SGaist
                  Lifetime Qt Champion
                  wrote on last edited by
                  #8

                  Can you share your doxygen config ? And which version is it ?

                  Interested in AI ? www.idiap.ch
                  Please read the Qt Code of Conduct - https://forum.qt.io/topic/113070/qt-code-of-conduct

                  V 1 Reply Last reply
                  0
                  • L Offline
                    L Offline
                    LuGRU
                    wrote on last edited by LuGRU
                    #9

                    doxygen 1.8.11
                    Qt 5.6 QtCreator 3.6.1

                    doxy config:
                    https://mega.nz/#!09tB3JgK!Z102QbGp-MetJ7O0-vdkq5uJmPVJWdngJj_VQrdMT1M

                    Tried with default generated by doxy, only enable QCH same result.

                    1 Reply Last reply
                    0
                    • SGaistS SGaist

                      Can you share your doxygen config ? And which version is it ?

                      V Offline
                      V Offline
                      victl
                      wrote on last edited by
                      #10

                      @SGaist I think the problem is related to the recent change of qt creator since version 3.6.1: the help browser's default showing widget is no longer QtWebkit, but QTextBrowser, which only implements a subset of css style. Please refer to this post

                      1 Reply Last reply
                      0

                      • Login

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