Tooltips

A tooltip is a brief, informative message that appears when a user interacts with an element in a graphical user interface (GUI). In DVT tooltips are initiated through a mouse-hover gesture. Tooltips can be triggered from the following areas:

• Code

Place the mouse cursor over an identifier in the editor. A tooltip shows information about the element under cursor:

• the comment associated with the element’s declaration (written above or the side), or the LRM documentation for predefined API

• scoping information for types (enclosing package)

• the full signature of methods

• direction of ports, etc.

Tooltips are available for all the types, methods, fields, macros, etc. from the source code files that DVT analyzes in your project.

• Problems

Place the mouse cursor over the problem highlighted range (squiggle underline).

The tooltip will display the error or warning message.

• Method Call Arguments Mapping

Place the editor cursor on a method call argument and use the Trigger Parameter Hints command.

The tooltip will list all the method declaration arguments along with their name, type, direction, and default value. Move the editor cursor to inspect argument mapping - the argument under the cursor is always highlighted.

• Comments Formatting
  • Markdown (recommended)
  • Javadoc
  • Natural Docs (deprecated)