mirror of
https://github.com/brl/mutter.git
synced 2025-06-13 16:59:30 +00:00
Fix gobs of gtk-doc warnings
https://bugzilla.gnome.org/show_bug.cgi?id=676856
This commit is contained in:
Tomeu Vizoso
committed by
Jasper St. Pierre
Jasper St. Pierre
parent
edeac1de09
commit
e0b698d365
@ -22,8 +22,8 @@
|
||||
* 02111-1307, USA.
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:Bell
|
||||
/*
|
||||
* SECTION:bell
|
||||
* @short_description: Ring the bell or flash the screen
|
||||
*
|
||||
* Sometimes, X programs "ring the bell", whatever that means. Mutter lets
|
||||
@ -52,7 +52,9 @@
|
||||
#include <config.h>
|
||||
#include "bell.h"
|
||||
#include "screen-private.h"
|
||||
#include "window-private.h"
|
||||
#include <meta/prefs.h>
|
||||
#include <meta/compositor.h>
|
||||
#ifdef HAVE_LIBCANBERRA
|
||||
#include <canberra-gtk.h>
|
||||
#endif
|
||||
|
||||
@ -28,30 +28,35 @@
|
||||
|
||||
#ifdef HAVE_XKB
|
||||
/**
|
||||
* meta_bell_notify:
|
||||
* @display: The display the bell event came in on
|
||||
* @xkb_ev: The bell event we just received
|
||||
*
|
||||
* Gives the user some kind of visual bell; in fact, this is our response
|
||||
* to any kind of bell request, but we set it up so that we only get
|
||||
* notified about visual bells, and X deals with audible ones.
|
||||
*
|
||||
* If the configure script found we had no XKB, this does not exist.
|
||||
*
|
||||
* \param display The display the bell event came in on
|
||||
* \param xkb_ev The bell event we just received
|
||||
*/
|
||||
void meta_bell_notify (MetaDisplay *display, XkbAnyEvent *xkb_ev);
|
||||
#endif
|
||||
|
||||
/**
|
||||
* meta_bell_set_audible:
|
||||
* @display: The display we're configuring
|
||||
* @audible: True for an audible bell, false for a visual bell
|
||||
*
|
||||
* Turns the bell to audible or visual. This tells X what to do, but
|
||||
* not Mutter; you will need to set the "visual bell" pref for that.
|
||||
*
|
||||
* If the configure script found we had no XKB, this is a no-op.
|
||||
*
|
||||
* \param display The display we're configuring
|
||||
* \param audible True for an audible bell, false for a visual bell
|
||||
*/
|
||||
void meta_bell_set_audible (MetaDisplay *display, gboolean audible);
|
||||
|
||||
/**
|
||||
* meta_bell_init:
|
||||
* @display: The display which is opening
|
||||
*
|
||||
* Initialises the bell subsystem. This involves intialising
|
||||
* XKB (which, despite being a keyboard extension, is the
|
||||
* place to look for bell notifications), then asking it
|
||||
@ -64,8 +69,6 @@ void meta_bell_set_audible (MetaDisplay *display, gboolean audible);
|
||||
* we will have HAVE_XKB undefined, which will cause this
|
||||
* function to be a no-op.
|
||||
*
|
||||
* \param display The display which is opening
|
||||
*
|
||||
* \bug There is a line of code that's never run that tells
|
||||
* XKB to reset the bell status after we quit. Bill H said
|
||||
* (<http://bugzilla.gnome.org/show_bug.cgi?id=99886#c12>)
|
||||
@ -75,9 +78,10 @@ void meta_bell_set_audible (MetaDisplay *display, gboolean audible);
|
||||
gboolean meta_bell_init (MetaDisplay *display);
|
||||
|
||||
/**
|
||||
* Shuts down the bell subsystem.
|
||||
* meta_bell_shutdown:
|
||||
* @display: The display which is closing
|
||||
*
|
||||
* \param display The display which is closing
|
||||
* Shuts down the bell subsystem.
|
||||
*
|
||||
* \bug This is never called! If we had XkbSetAutoResetControls
|
||||
* enabled in meta_bell_init(), this wouldn't be a problem, but
|
||||
@ -86,11 +90,12 @@ gboolean meta_bell_init (MetaDisplay *display);
|
||||
void meta_bell_shutdown (MetaDisplay *display);
|
||||
|
||||
/**
|
||||
* meta_bell_notify_frame_destroy:
|
||||
* @frame: The frame which is being destroyed
|
||||
*
|
||||
* Deals with a frame being destroyed. This is important because if we're
|
||||
* using a visual bell, we might be flashing the edges of the frame, and
|
||||
* so we'd have a timeout function waiting ready to un-flash them. If the
|
||||
* frame's going away, we can tell the timeout not to bother.
|
||||
*
|
||||
* \param frame The frame which is being destroyed
|
||||
*/
|
||||
void meta_bell_notify_frame_destroy (MetaFrame *frame);
|
||||
|
||||
@ -24,7 +24,7 @@
|
||||
* 02111-1307, USA.
|
||||
*/
|
||||
|
||||
/**
|
||||
/*
|
||||
* SECTION:MetaDisplay
|
||||
* @short_description: Handles operations on an X display.
|
||||
*
|
||||
@ -83,7 +83,7 @@
|
||||
g == META_GRAB_OP_KEYBOARD_ESCAPING_DOCK || \
|
||||
g == META_GRAB_OP_KEYBOARD_ESCAPING_GROUP)
|
||||
|
||||
/**
|
||||
/*
|
||||
* SECTION:pings
|
||||
*
|
||||
* Sometimes we want to see whether a window is responding,
|
||||
@ -1132,6 +1132,7 @@ meta_display_close (MetaDisplay *display,
|
||||
/**
|
||||
* meta_display_screen_for_root:
|
||||
* @display: a #MetaDisplay
|
||||
* @xroot: a X window
|
||||
*
|
||||
* Return the #MetaScreen corresponding to a specified X root window ID.
|
||||
*
|
||||
@ -3638,7 +3639,7 @@ meta_display_notify_window_created (MetaDisplay *display,
|
||||
* @display: A #MetaDisplay
|
||||
* @xwindow: An X11 window
|
||||
*
|
||||
* Returns %TRUE iff window is one of mutter's internal "no focus" windows
|
||||
* Returns: %TRUE iff window is one of mutter's internal "no focus" windows
|
||||
* (there is one per screen) which will have the focus when there is no
|
||||
* actual client window focused.
|
||||
*/
|
||||
@ -4098,6 +4099,8 @@ meta_display_end_grab_op (MetaDisplay *display,
|
||||
|
||||
/**
|
||||
* meta_display_get_grab_op:
|
||||
* @display: The #MetaDisplay that the window is on
|
||||
|
||||
* Gets the current grab operation, if any.
|
||||
*
|
||||
* Return value: the current grab operation, or %META_GRAB_OP_NONE if
|
||||
@ -4469,6 +4472,7 @@ meta_is_syncing (void)
|
||||
|
||||
/**
|
||||
* meta_set_syncing:
|
||||
* @setting: whether to turn syncing on or off
|
||||
*
|
||||
* A handy way to turn on synchronisation on or off for every display.
|
||||
*/
|
||||
@ -5689,6 +5693,7 @@ meta_display_get_compositor_version (MetaDisplay *display,
|
||||
|
||||
/**
|
||||
* meta_display_get_xinput_opcode: (skip)
|
||||
* @display: a #MetaDisplay
|
||||
*
|
||||
*/
|
||||
int
|
||||
@ -5701,7 +5706,7 @@ meta_display_get_xinput_opcode (MetaDisplay *display)
|
||||
* meta_display_supports_extended_barriers:
|
||||
* @display: a #MetaDisplay
|
||||
*
|
||||
* Returns whether the X server supports extended barrier
|
||||
* Returns: whether the X server supports extended barrier
|
||||
* features as defined in version 2.3 of the XInput 2
|
||||
* specification.
|
||||
*
|
||||
@ -5716,6 +5721,7 @@ meta_display_supports_extended_barriers (MetaDisplay *display)
|
||||
|
||||
/**
|
||||
* meta_display_get_xdisplay: (skip)
|
||||
* @display: a #MetaDisplay
|
||||
*
|
||||
*/
|
||||
Display *
|
||||
@ -5726,6 +5732,7 @@ meta_display_get_xdisplay (MetaDisplay *display)
|
||||
|
||||
/**
|
||||
* meta_display_get_compositor: (skip)
|
||||
* @display: a #MetaDisplay
|
||||
*
|
||||
*/
|
||||
MetaCompositor *
|
||||
|
||||
@ -106,6 +106,7 @@ meta_group_unref (MetaGroup *group)
|
||||
|
||||
/**
|
||||
* meta_window_get_group: (skip)
|
||||
* @window: a #MetaWindow
|
||||
*
|
||||
*/
|
||||
MetaGroup*
|
||||
@ -204,6 +205,8 @@ meta_window_shutdown_group (MetaWindow *window)
|
||||
|
||||
/**
|
||||
* meta_display_lookup_group: (skip)
|
||||
* @display: a #MetaDisplay
|
||||
* @group_leader: a X window
|
||||
*
|
||||
*/
|
||||
MetaGroup*
|
||||
@ -279,6 +282,8 @@ meta_group_get_startup_id (MetaGroup *group)
|
||||
|
||||
/**
|
||||
* meta_group_property_notify: (skip)
|
||||
* @group: a #MetaGroup
|
||||
* @event: a X event
|
||||
*
|
||||
*/
|
||||
gboolean
|
||||
|
||||
@ -3861,6 +3861,11 @@ meta_keybindings_set_custom_handler (const gchar *name,
|
||||
|
||||
/**
|
||||
* meta_keybindings_switch_window: (skip)
|
||||
* @display: a #MetaDisplay
|
||||
* @screen: a #MetaScreen
|
||||
* @event_window: a #MetaWindow
|
||||
* @event: a #XIDeviceEvent
|
||||
* @binding: a #MetaKeyBinding
|
||||
*
|
||||
*/
|
||||
void
|
||||
|
||||
@ -581,8 +581,8 @@ meta_quit (MetaExitCode code)
|
||||
|
||||
/**
|
||||
* prefs_changed_callback:
|
||||
* @pref Which preference has changed
|
||||
* @data Arbitrary data (which we ignore)
|
||||
* @pref: Which preference has changed
|
||||
* @data: Arbitrary data (which we ignore)
|
||||
*
|
||||
* Called on pref changes. (One of several functions of its kind and purpose.)
|
||||
*
|
||||
|
||||
@ -700,6 +700,8 @@ handle_preference_update_int (GSettings *settings,
|
||||
|
||||
/**
|
||||
* meta_prefs_add_listener: (skip)
|
||||
* @func: a #MetaPrefsChangedFunc
|
||||
* @user_data: data passed to the function
|
||||
*
|
||||
*/
|
||||
void
|
||||
@ -717,6 +719,8 @@ meta_prefs_add_listener (MetaPrefsChangedFunc func,
|
||||
|
||||
/**
|
||||
* meta_prefs_remove_listener: (skip)
|
||||
* @func: a #MetaPrefsChangedFunc
|
||||
* @user_data: data passed to the function
|
||||
*
|
||||
*/
|
||||
void
|
||||
|
||||
@ -3484,6 +3484,7 @@ meta_screen_get_display (MetaScreen *screen)
|
||||
|
||||
/**
|
||||
* meta_screen_get_xroot: (skip)
|
||||
* @screen: A #MetaScreen
|
||||
*
|
||||
*/
|
||||
Window
|
||||
@ -3514,6 +3515,7 @@ meta_screen_get_size (MetaScreen *screen,
|
||||
|
||||
/**
|
||||
* meta_screen_get_compositor_data: (skip)
|
||||
* @screen: A #MetaScreen
|
||||
*
|
||||
*/
|
||||
gpointer
|
||||
@ -3582,6 +3584,7 @@ meta_screen_get_active_workspace_index (MetaScreen *screen)
|
||||
|
||||
/**
|
||||
* meta_screen_get_active_workspace:
|
||||
* @screen: A #MetaScreen
|
||||
*
|
||||
* Returns: (transfer none): The current workspace
|
||||
*/
|
||||
|
||||
@ -1,5 +1,20 @@
|
||||
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
|
||||
|
||||
/*
|
||||
* SECTION:stack-tracker
|
||||
* @short_description: Track stacking order for compositor
|
||||
*
|
||||
* #MetaStackTracker maintains the most accurate view we have at a
|
||||
* given point of time of the ordering of the children of the root
|
||||
* window (including override-redirect windows.) This is used to order
|
||||
* the windows when the compositor draws them.
|
||||
*
|
||||
* By contrast, #MetaStack is responsible for keeping track of how we
|
||||
* think that windows *should* be ordered. For windows we manage
|
||||
* (non-override-redirect windows), the two stacking orders will be
|
||||
* the same.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2009 Red Hat, Inc.
|
||||
*
|
||||
@ -616,7 +631,7 @@ meta_stack_tracker_configure_event (MetaStackTracker *tracker,
|
||||
* @windows: location to store list of windows, or %NULL
|
||||
* @n_windows: location to store count of windows, or %NULL
|
||||
*
|
||||
* Returns the most current view we have of the stacking order
|
||||
* @windows will contain the most current view we have of the stacking order
|
||||
* of the children of the root window. The returned array contains
|
||||
* everything: InputOnly windows, override-redirect windows,
|
||||
* hidden windows, etc. Some of these will correspond to MetaWindow
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
|
||||
|
||||
/**
|
||||
/*
|
||||
* SECTION:stack
|
||||
* @short_description: Which windows cover which other windows
|
||||
*/
|
||||
|
||||
@ -225,6 +225,7 @@ utf8_fputs (const char *str,
|
||||
|
||||
/**
|
||||
* meta_free_gslist_and_elements: (skip)
|
||||
* @list_to_deep_free: list to deep free
|
||||
*
|
||||
*/
|
||||
void
|
||||
@ -599,6 +600,16 @@ append_argument (GPtrArray *args,
|
||||
|
||||
/**
|
||||
* meta_show_dialog: (skip)
|
||||
* @type: type of dialog
|
||||
* @message: message
|
||||
* @timeout: timeout
|
||||
* @display: display
|
||||
* @ok_text: text for Ok button
|
||||
* @cancel_text: text for Cancel button
|
||||
* @icon_name: icon name
|
||||
* @transient_for: window XID of parent
|
||||
* @columns: columns
|
||||
* @entries: entries
|
||||
*
|
||||
*/
|
||||
GPid
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
|
||||
|
||||
/**
|
||||
/*
|
||||
* SECTION:window-props
|
||||
* @short_description: #MetaWindow property handling
|
||||
*
|
||||
|
||||
@ -2130,7 +2130,7 @@ set_net_wm_state (MetaWindow *window)
|
||||
* @window: a #MetaWindow
|
||||
* @workspace: a #MetaWorkspace
|
||||
*
|
||||
* Returns whether @window is displayed on @workspace, or whether it
|
||||
* Returns: whether @window is displayed on @workspace, or whether it
|
||||
* will be displayed on all workspaces.
|
||||
*/
|
||||
gboolean
|
||||
@ -3629,6 +3629,7 @@ meta_window_maximize (MetaWindow *window,
|
||||
|
||||
/**
|
||||
* meta_window_get_maximized:
|
||||
* @window: a #MetaWindow
|
||||
*
|
||||
* Gets the current maximization state of the window, as combination
|
||||
* of the %META_MAXIMIZE_HORIZONTAL and %META_MAXIMIZE_VERTICAL flags;
|
||||
@ -3644,6 +3645,7 @@ meta_window_get_maximized (MetaWindow *window)
|
||||
|
||||
/**
|
||||
* meta_window_is_fullscreen:
|
||||
* @window: a #MetaWindow
|
||||
*
|
||||
* Return value: %TRUE if the window is currently fullscreen
|
||||
*/
|
||||
@ -3690,6 +3692,7 @@ meta_window_get_all_monitors (MetaWindow *window, gsize *length)
|
||||
|
||||
/**
|
||||
* meta_window_is_screen_sized:
|
||||
* @window: A #MetaWindow
|
||||
*
|
||||
* Return value: %TRUE if the window is occupies the
|
||||
* the whole screen (all monitors).
|
||||
@ -3741,6 +3744,7 @@ meta_window_is_monitor_sized (MetaWindow *window)
|
||||
|
||||
/**
|
||||
* meta_window_is_on_primary_monitor:
|
||||
* @window: a #MetaWindow
|
||||
*
|
||||
* Return value: %TRUE if the window is on the primary monitor
|
||||
*/
|
||||
@ -3752,6 +3756,7 @@ meta_window_is_on_primary_monitor (MetaWindow *window)
|
||||
|
||||
/**
|
||||
* meta_window_requested_bypass_compositor:
|
||||
* @window: a #MetaWindow
|
||||
*
|
||||
* Return value: %TRUE if the window requested to bypass the compositor
|
||||
*/
|
||||
@ -3763,6 +3768,7 @@ meta_window_requested_bypass_compositor (MetaWindow *window)
|
||||
|
||||
/**
|
||||
* meta_window_requested_dont_bypass_compositor:
|
||||
* @window: a #MetaWindow
|
||||
*
|
||||
* Return value: %TRUE if the window requested to opt out of unredirecting
|
||||
*/
|
||||
@ -10333,6 +10339,7 @@ meta_window_stack_just_below (MetaWindow *window,
|
||||
|
||||
/**
|
||||
* meta_window_get_user_time:
|
||||
* @window: a #MetaWindow
|
||||
*
|
||||
* The user time represents a timestamp for the last time the user
|
||||
* interacted with this window. Note this property is only available
|
||||
@ -10501,6 +10508,7 @@ meta_window_unset_demands_attention (MetaWindow *window)
|
||||
|
||||
/**
|
||||
* meta_window_get_frame: (skip)
|
||||
* @window: a #MetaWindow
|
||||
*
|
||||
*/
|
||||
MetaFrame *
|
||||
@ -10541,7 +10549,7 @@ meta_window_is_shaded (MetaWindow *window)
|
||||
* meta_window_is_override_redirect:
|
||||
* @window: A #MetaWindow
|
||||
*
|
||||
* Returns if this window isn't managed by mutter; it will
|
||||
* Returns: %TRUE if this window isn't managed by mutter; it will
|
||||
* control its own positioning and mutter won't draw decorations
|
||||
* among other things. In X terminology this is "override redirect".
|
||||
*/
|
||||
@ -10609,6 +10617,7 @@ meta_window_get_display (MetaWindow *window)
|
||||
|
||||
/**
|
||||
* meta_window_get_xwindow: (skip)
|
||||
* @window: a #MetaWindow
|
||||
*
|
||||
*/
|
||||
Window
|
||||
@ -10819,7 +10828,7 @@ meta_window_get_role (MetaWindow *window)
|
||||
* meta_window_get_title:
|
||||
* @window: a #MetaWindow
|
||||
*
|
||||
* Returns the current title of the window.
|
||||
* Returns: the current title of the window.
|
||||
*/
|
||||
const char *
|
||||
meta_window_get_title (MetaWindow *window)
|
||||
@ -11046,6 +11055,7 @@ meta_window_get_frame_type (MetaWindow *window)
|
||||
|
||||
/**
|
||||
* meta_window_get_frame_bounds:
|
||||
* @window: a #MetaWindow
|
||||
*
|
||||
* Gets a region representing the outer bounds of the window's frame.
|
||||
*
|
||||
@ -11083,6 +11093,7 @@ meta_window_is_attached_dialog (MetaWindow *window)
|
||||
|
||||
/**
|
||||
* meta_window_get_tile_match:
|
||||
* @window: a #MetaWindow
|
||||
*
|
||||
* Returns the matching tiled window on the same monitor as @window. This is
|
||||
* the topmost tiled window in a complementary tile mode that is:
|
||||
|
||||
Reference in New Issue
Block a user