docs: Improve gtk_window_set_interactive_debugging() docs

This function is recommended only if you override the default
key shortcuts for the Inspector.
This commit is contained in:
Kjell Ahlstedt
2024-08-14 16:57:55 +02:00
parent a14e426fb5
commit dc3def1afd

View File

@@ -6261,11 +6261,12 @@ G_GNUC_END_IGNORE_DEPRECATIONS
* and to useful debugging tools.
*
* This function allows applications that already use
* <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> (or <kbd>D</kbd>) for their
* own key shortcuts to add a different shortcut. If you are not overriding
* the default key shortcuts for the inspector, you should not be calling this
* function. For instance, adding a menu item to call this function isnt
* recommended: the Inspector is a debugging and development tool.
* <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd>
* (or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd>)
* for their own key shortcuts to add a different shortcut to open the Inspector.
*
* If you are not overriding the default key shortcuts for the Inspector,
* you should not use this function.
*/
void
gtk_window_set_interactive_debugging (gboolean enable)