To hover, place the mouse cursor over any element (in this case, a "text" element). When enabled, hovering causes a tool tip message to temporarily appear in a text box near the cursor. In the context of Hover Help, the contents of the message include some or all of the following information:
|
Location |
The file in which the PHP element was declared. |
|
Short Description |
This is the short description taken from the PHP element's PHPDoc. |
|
Signature |
The PHP element's return type. |
Hovering over a class / interface reference presents the location of the class / interface and a short description.
Hovering over a function call displays the function's location, its signature (including the return type) and the short description.
Hover over a function. The tool tip will appear. It includes the following information:
Variable type, name, return type
Variable's location path
Variable's short description
Hovering over class variables displays the function's location and the short description.
Hover over the class reference (the variable $sugar in the last line of code, below). The tool tip is displayed and includes the following:
Class name
Correct File location where the class is declared
Short Description of the class
Consider the following PHP code holding a class (coffee) containing functions and a PHPdoc description. Each tool tip appears separately while hovering over the respective class and function declaration.
For global variables defined outside the current file, hovering the variable will display the location (file and path) of the variable's declaration.
