Writing Qt documentation

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

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

[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_D]

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