Doxygen 'returns' keyword not shown

[rike]

Given that a function declaration has a doxygen-style function description. When hovering over the function implementation or a reference of the function, only keywords such as “summary”, “param” etc. are shown.

How do I also display the “returns” value?

Attachments:

You must be logged in to view attached files.

[support]

Hi,

Thanks for reporting this, looks like a bug on our side. Please try this build: VisualGDB-6.0.4.5003.msi

[Timo Engelmann]

Hi,

In the meantime, we updated to VisualGDB beta 6.0.4 and tried this fix. Now the <returns> part will be displayed in IntelliSense.
However, there are some further issues if display the comment via IntelliSense::

1. Long content is not fully displayed. If the comment is longer than approximately 18 lines, the additional lines are not displayed via IntelliSense.
   – intellisense_comment_01.png => Method comment block.
   – intellisense_comment_02.png => Result if mouse hover. => the last lines are not displayed.
   The only solution is to delete the last letter of the method name and type it again.
   Then another dialog is displayed: intellisense_comment_03.png
2. Too much space between the comment content and the ‘Returns’ part. Between the blocks, there are normally no empty line spaces. But the ‘returns’ section begins with three empty lines.
3. Inconsistency in handling of a new line. A </param>, end tag at the beginning of a new line creates a space between the ending block and the next. This is good. The </summary> does not do this.

Can you check this?
It would be nice if this issus are fixed at the next beta.

Best wishes,
Timo

 

Attachments:

You must be logged in to view attached files.

[support]

Hi,

The 20-line limit in tooltips is by design to prevent them from filling the entire screen if VisualGDB attributed too many comments to the function declaration. You can easily change it via Tools->Options->Text Editor->C/C++(VisualGDB)->Advanced->Code Completion->Tooltip line limit.

The excessive empty lines were indeed due to a bug. We have fixed it in this build: VisualGDB-6.0.4.5135.msi. We also added a setting (Tools->Options->Text Editor->C/C++(VisualGDB)->Advanced->Code Completion->Condense function summaries) that allows removing extra lines between function argument descriptions, “returns” part and other similar blocks (requires reopening the project).

The </param> and </summary> should work the same – VisualGDB would trim the empty line at the end, and re-insert it on a higher level (between different parameters and different high-level blocks like summary or returns). If you meant something else, feel free to provide more details and we will look into it.

 

Attachments:

You must be logged in to view attached files.

[Author]

Posts