- This topic has 5 replies, 2 voices, and was last updated 6 years, 1 month ago by
.
-
Posts
-
In Microsoft Visual Studio C++, variables, functions, etc. can be described using special comments.
more info. =vs-2017This description is used in the Intellisense.
In VisualGDB there is a little bit strange behavior in this respect.
If you type e.g. a function name in the Code Editor, Intellisense proposal list will show matching entries. The help text for the entries are displayed with line wrap, but the format tags are displayed also (see VisualGDB_proposal_list.png).
The same behavior when moving the mouse over an existing code (see VisualGDB_mouse_hover.png)
But if typing the bracket after a function name, the help text will be displayed without line wrap but now the format tags are not shown (see VisualGDB_typing_bracket.png).
If the help text source (comment block above the function declaration) don’t use the <para> tag, then the help text is ok at mouse hover.
Without <para> tag:
/// <summary> Method to get one of the history entry of qualified pin states. /// The pin signal profile (on/off times) is recorded and qualified. /// This method returns one of the last qualified states. /// Return: /// <c> qualifiedPinState_t::UNKOWN </c> No qualification available since system startup. /// <c> qualifiedPinState_t::SHORT_OFF </c> The pin was off for a short time (500ms). /// <c> qualifiedPinState_t::MID_OFF </c> The pin was off for a mid time (1.5s). /// <c> qualifiedPinState_t::LONG_OFF </c> The pin was off for a long time (5s). /// <c> qualifiedPinState_t::VERY_LONG_OFF </c> The pin was on for a very long time (10s). /// <c> qualifiedPinState_t::SHORT_ON </c> The pin was on for a short time (500ms). /// <c> qualifiedPinState_t::MID_ON </c> The pin was on for a mid time (1.5s). /// <c> qualifiedPinState_t::LONG_ON </c> The pin was on for a long time (5s). /// <c> qualifiedPinState_t::VERY_LONG_ON </c> The pin was on for a very long time (10s). </summary> /// <param name='index'> /// The index of the history entries. There are maximum 8 entries available. /// The index 0 is the last qualified state and can also get by using the method getLastQualifiedState(). </param> qualifiedPinState_t getQualifiedStateHistory(uint8_t index);
With <para> tag:
/// <summary> Method to get one of the history entry of qualified pin states. /// <para> The pin signal profile (on/off times) is recorded and qualified. </para> /// <para> This method returns one of the last qualified states. </para> /// <para> Return: </para> /// <para> <c> qualifiedPinState_t::UNKOWN </c> No qualification available since system startup. </para> /// <para> <c> qualifiedPinState_t::SHORT_OFF </c> The pin was off for a short time (500ms). </para> /// <para> <c> qualifiedPinState_t::MID_OFF </c> The pin was off for a mid time (1.5s). </para> /// <para> <c> qualifiedPinState_t::LONG_OFF </c> The pin was off for a long time (5s). </para> /// <para> <c> qualifiedPinState_t::VERY_LONG_OFF </c> The pin was on for a very long time (10s). </para> /// <para> <c> qualifiedPinState_t::SHORT_ON </c> The pin was on for a short time (500ms). </para> /// <para> <c> qualifiedPinState_t::MID_ON </c> The pin was on for a mid time (1.5s). </para> /// <para> <c> qualifiedPinState_t::LONG_ON </c> The pin was on for a long time (5s). </para> /// <para> <c> qualifiedPinState_t::VERY_LONG_ON </c> The pin was on for a very long time (10s). </para> </summary> /// <param name='index'> /// The index of the history entries. There are maximum 8 entries available. /// The index 0 is the last qualified state and can also get by using the method getLastQualifiedState(). </param> qualifiedPinState_t getQualifiedStateHistory(uint8_t index);
Attached the screenshots. (three from VisualGDB and one from Microsoft Visual Studio C++)
And one other point:
It would be nice if the <c> tag is shown with a monospace font.Thanks,
TimoHi,
No problem. We have fixed the issues you described in this build: http://sysprogs.com/files/tmp/VisualGDB-5.4.7.2482.msi.
We should be able to support showing the contents of <p> with a monospace font after we switch our tooltip mechanism to a newer API, once we drop support for VS2008, however unfortunately we cannot give any time estimates on that.
Hi VisualGDB Team,
another thing regarding intellisense quick help. Therefore as addition to this “issue”.
In enums it is very common to write comments behind the lines.
Unfortunately the VisualGDB QuickHelp don’t show this comments.I have compared this with VisualStudio native behavior and copy the result to a picture attached to this ticket.
Can you check this please and tell me if I make something wrong or if not, can you fix this in the next release?
Additionally it would be perfect, if VisualGDB insert a line wrap is a <br> command will be used – this is much more faster than the <para></para> syntax.
Thank you!
Best regards TimoHi,
No problem and thanks for reporting this. We have fixed it in the following build: http://sysprogs.com/files/tmp/VisualGDB-5.4.7.2519.msi.
- You must be logged in to reply to this topic.