Good evening, everyone. I can’t seem to get the long description of a source to appear when I hover my mouse over it.
Here are some screenshots.
Can you help me?
Thanks.
01
02
Were you ever able to? It’s not a feature I am aware of?
I’ve never seen this field…
Are you using some special extension?
Hi,
It did it in the past?
Maybe there is an IDE’s global option…
But, from the “…” button’s tootip, this feature is meant to set a long descripton on the generated code, not on the hover tooltip…
Look in ClarionHelp.chm for XML Documentation and XML Documentation Comments
even though it’s mislabeled as .NET only
also, as implied in the Other examples a single line comment after a prototype will also be treated as XML documentation, which then appears in the tip help. Which is likely what you’re relying on with the description field in the template shown above
see Builtins.clw as an example of prototypes with more elaborate xml documenation
!!! <summary>
!!! Searches for a substring in a string.
!!! </summary>
!!! <param name="substring">A string constant, variable, or expression that contains the string for which to search. You should CLIP a variable substring so INSTRING will not look for a match that contains the trailing spaces in the variable.</param>
!!! <param name="str">A string constant, or the label of the STRING, CSTRING, or PSTRING variable to be searched.</param>
!!! <param name="step">A numeric constant, variable, or expression which specifies the step length of the search. A step of 1 will search for the substring beginning at every character in the string, a step of 2 starts at every other character, and so on. A negative step value (-1) will search from right to left within the string. If step is omitted, the step length defaults to the length of the substring.</param>
!!! <param name="start">A numeric constant, variable, or expression which specifies where to begin the search of the string. If omitted, the search starts at the first character position. In Clarion#, start is zero (0) based (i.e., zero (0) starts at the first character position).</param>
!!! <returns>The step number on which the substring was found. If the substring is not found in the string, INSTRING returns zero.</returns>
INSTRING(STRING substring, STRING str, UNSIGNED step=0, UNSIGNED start=1),UNSIGNED,NAME('Cla$StackINSTRING')
the above entry was copied out of builtins.clw
Thanks Mark,
but what does it mean?
Is it possible to get a user defined procedure description (short or long) to appear in a popup when using the procedure within an embed, or source? If so, how?
I don’t use apps, so I’m not sure about the limitations of embeds
that said, when I open School.APP and hover over ThisWindow.Run()
I do get tip help
I opened school.app and tried a few things
It did show tip help form a short description on a method I added to ThisWindow
It did show the prototype for derived methods
But I had to switch to the module editor to add to a method to Thiswindow – which seemed odd to me that there was no embed point inside of a class, I can only imagine all of the work arounds that you guys must find to work that way
I suggest giving the Monaco Embeditor a try
I believe it’s easy to enable with ClarionAssistant
Just a latched button on the your Clarion.IDE toolbar
I’ve heard that Monaco is the same base editor that’s used inside of VSCode
(here’s a link that has “CA Embeditor” highlighted)