Commit c8ea4d4d authored by Jérôme Guelfucci's avatar Jérôme Guelfucci Committed by Simon Steinbeiss

Improve docs for xfce_panel_plugin_position_widget (Bug #9438)

Fix small typos and be more explicit about what the function does. It
does not actually position the widget, it computes the coordinates
needed to position it.
parent 02248cf9
......@@ -2624,11 +2624,11 @@ xfce_panel_plugin_arrow_type (XfcePanelPlugin *plugin)
* @menu_widget : a #GtkWidget that will be used as popup menu.
* @attach_widget : (allow-none): a #GtkWidget relative to which the menu should be positioned.
* @x : (out): return location for the x coordinate.
* @y : (out): return location for the x coordinate.
* @y : (out): return location for the y coordinate.
*
* The menu widget is positioned relative to @attach_widget.
* If @attach_widget is NULL, the menu widget is instead positioned
* relative to @panel_plugin.
* Computes the x and y coordinates to position the @menu_widget
* relative to @attach_widget. If @attach_widget is NULL, the computed
* position will be relative to @plugin.
*
* This function is intended for custom menu widgets.
* For a regular #GtkMenu you should use xfce_panel_plugin_position_menu()
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment