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. Writing Qt documentation
Forum Updated to NodeBB v4.3 + New Features

Writing Qt documentation

Scheduled Pinned Locked Moved Solved General and Desktop
3 Posts 2 Posters 321 Views 1 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.
  • Please_Help_me_DP Offline
    Please_Help_me_DP Offline
    Please_Help_me_D
    wrote on last edited by
    #1

    Hi,

    I'm trying to write comment to a function that should appear when I choose this method (function) from a list of methods (functions). I do it with code as following:

        /*!
          Takes coordinates in pixels and returns in range [0, 1].
          y - is the position of the center of rectangle
        */
    

    But the hint that is appeared is written in a single line.
    How to start new line?

    sierdzioS 1 Reply Last reply
    0
    • Please_Help_me_DP Please_Help_me_D

      Hi,

      I'm trying to write comment to a function that should appear when I choose this method (function) from a list of methods (functions). I do it with code as following:

          /*!
            Takes coordinates in pixels and returns in range [0, 1].
            y - is the position of the center of rectangle
          */
      

      But the hint that is appeared is written in a single line.
      How to start new line?

      sierdzioS Offline
      sierdzioS Offline
      sierdzio
      Moderators
      wrote on last edited by
      #2

      @Please_Help_me_D said in Writing Qt documentation:

      How to start new line?

      Add 2 newlines in the comment, so that there is a paragraph. Qt Creator may not show the second paragraph, though - I think it only shows the brief description.

      If you wonder about comment syntax - you can learn more about it in qdoc documentation or (better) in Doxygen documentation.

      (Z(:^

      Please_Help_me_DP 1 Reply Last reply
      6
      • sierdzioS sierdzio

        @Please_Help_me_D said in Writing Qt documentation:

        How to start new line?

        Add 2 newlines in the comment, so that there is a paragraph. Qt Creator may not show the second paragraph, though - I think it only shows the brief description.

        If you wonder about comment syntax - you can learn more about it in qdoc documentation or (better) in Doxygen documentation.

        Please_Help_me_DP Offline
        Please_Help_me_DP Offline
        Please_Help_me_D
        wrote on last edited by
        #3

        @sierdzio thank you!
        Seems to me that Qt really doesn't show more than one line in appeared hint

        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