How to create a tooltip for the documentation of an ST-element?

The ST-editor shows a tooltip for the documentation of an element, if you hover over this element.
Example for a tooltip shown for a variable:
images/download/attachments/406126702/FlyOver-version-1-modificationdate-1530005876253-api-v2.png

You are able to define the text that is shown as tooltip for user-defined elements:

  1. Go to the user-defined element for that you want to insert or change a tooltip. If this element is not the declaration, go to its declaration: context menu in ST-editor, Open Declaration

  2. Before the declaration of the element, enter a comment. The comment may have one or more lines.
    If you want to format the text, enter the appropriate HTML-tags (e.g. <br> for a line wrap). Search the Internet for documentation on the HTML-tags.
    Example for comment before the declared variable Init:

    VAR
    /* 'Init' is set to '<b>TRUE</b>' when the program is started. <br>
    * Then 'Init' is used to initialized the hardware.
    */
    Init : BOOL;
    END_VAR
  3. Go back to the usage (e.g. by using the method described under "Finding references for element") and hover over the element in order to display the new/changed tooltip. Or just point to the declared element.
    Example for changed tooltip

    images/download/attachments/406126707/FlyOver2-version-1-modificationdate-1530005910797-api-v2.png

images/s/b2ic8e/9012/1ca6q62/_/images/icons/emoticons/information.svg logi.cals recommends to install and use the most current versions of logi.CAD 3 and the runtime system so that the latest features and problem fixes according to the release notes are provided in the used version.


Did this article help you? Did you find the requested information in this user documentation?
If not, contact the support team of logi.cals. State your questions or suggestions to improve/enhance the user documentation as detailed as possible.