stack: Style and introspection doc fixes

https://gitlab.gnome.org/GNOME/mutter/merge_requests/669
This commit is contained in:
Marco Trevisan (Treviño) 2019-07-04 13:03:40 +02:00
parent 6d8293a422
commit 62f4e0501f
2 changed files with 62 additions and 61 deletions

View File

@ -52,7 +52,6 @@ static void meta_window_set_stack_position_no_sync (MetaWindow *window,
static void stack_do_relayer (MetaStack *stack); static void stack_do_relayer (MetaStack *stack);
static void stack_do_constrain (MetaStack *stack); static void stack_do_constrain (MetaStack *stack);
static void stack_do_resort (MetaStack *stack); static void stack_do_resort (MetaStack *stack);
static void stack_ensure_sorted (MetaStack *stack); static void stack_ensure_sorted (MetaStack *stack);
enum enum
@ -969,7 +968,7 @@ stack_ensure_sorted (MetaStack *stack)
stack_do_resort (stack); stack_do_resort (stack);
} }
MetaWindow* MetaWindow *
meta_stack_get_top (MetaStack *stack) meta_stack_get_top (MetaStack *stack)
{ {
stack_ensure_sorted (stack); stack_ensure_sorted (stack);
@ -980,7 +979,7 @@ meta_stack_get_top (MetaStack *stack)
return NULL; return NULL;
} }
MetaWindow* MetaWindow *
meta_stack_get_bottom (MetaStack *stack) meta_stack_get_bottom (MetaStack *stack)
{ {
GList *link; GList *link;
@ -994,7 +993,7 @@ meta_stack_get_bottom (MetaStack *stack)
return NULL; return NULL;
} }
MetaWindow* MetaWindow *
meta_stack_get_above (MetaStack *stack, meta_stack_get_above (MetaStack *stack,
MetaWindow *window, MetaWindow *window,
gboolean only_within_layer) gboolean only_within_layer)
@ -1019,7 +1018,7 @@ meta_stack_get_above (MetaStack *stack,
return above; return above;
} }
MetaWindow* MetaWindow *
meta_stack_get_below (MetaStack *stack, meta_stack_get_below (MetaStack *stack,
MetaWindow *window, MetaWindow *window,
gboolean only_within_layer) gboolean only_within_layer)
@ -1078,7 +1077,7 @@ window_can_get_default_focus (MetaWindow *window)
return TRUE; return TRUE;
} }
static MetaWindow* static MetaWindow *
get_default_focus_window (MetaStack *stack, get_default_focus_window (MetaStack *stack,
MetaWorkspace *workspace, MetaWorkspace *workspace,
MetaWindow *not_this_one, MetaWindow *not_this_one,
@ -1117,7 +1116,7 @@ get_default_focus_window (MetaStack *stack,
return NULL; return NULL;
} }
MetaWindow* MetaWindow *
meta_stack_get_default_focus_window_at_point (MetaStack *stack, meta_stack_get_default_focus_window_at_point (MetaStack *stack,
MetaWorkspace *workspace, MetaWorkspace *workspace,
MetaWindow *not_this_one, MetaWindow *not_this_one,
@ -1128,7 +1127,7 @@ meta_stack_get_default_focus_window_at_point (MetaStack *stack,
TRUE, root_x, root_y); TRUE, root_x, root_y);
} }
MetaWindow* MetaWindow *
meta_stack_get_default_focus_window (MetaStack *stack, meta_stack_get_default_focus_window (MetaStack *stack,
MetaWorkspace *workspace, MetaWorkspace *workspace,
MetaWindow *not_this_one) MetaWindow *not_this_one)
@ -1137,7 +1136,7 @@ meta_stack_get_default_focus_window (MetaStack *stack,
FALSE, 0, 0); FALSE, 0, 0);
} }
GList* GList *
meta_stack_list_windows (MetaStack *stack, meta_stack_list_windows (MetaStack *stack,
MetaWorkspace *workspace) MetaWorkspace *workspace)
{ {
@ -1221,7 +1220,7 @@ compare_just_window_stack_position (void *a,
return 0; /* not reached */ return 0; /* not reached */
} }
GList* GList *
meta_stack_get_positions (MetaStack *stack) meta_stack_get_positions (MetaStack *stack)
{ {
GList *tmp; GList *tmp;

View File

@ -108,7 +108,7 @@ G_DECLARE_FINAL_TYPE (MetaStack, meta_stack, META, STACK, GObject)
* *
* Returns: The new stack. * Returns: The new stack.
*/ */
MetaStack *meta_stack_new (MetaDisplay *display); MetaStack * meta_stack_new (MetaDisplay *display);
/** /**
* meta_stack_add: * meta_stack_add:
@ -208,7 +208,7 @@ void meta_stack_thaw (MetaStack *stack);
* Returns: The top window on the stack, or %NULL in the vanishingly unlikely * Returns: The top window on the stack, or %NULL in the vanishingly unlikely
* event that you have no windows on your screen whatsoever. * event that you have no windows on your screen whatsoever.
*/ */
MetaWindow* meta_stack_get_top (MetaStack *stack); MetaWindow * meta_stack_get_top (MetaStack *stack);
/** /**
* meta_stack_get_bottom: * meta_stack_get_bottom:
@ -218,7 +218,7 @@ MetaWindow* meta_stack_get_top (MetaStack *stack);
* always the desktop, this isn't the most useful of functions, and nobody * always the desktop, this isn't the most useful of functions, and nobody
* actually calls it. We should probably get rid of it. * actually calls it. We should probably get rid of it.
*/ */
MetaWindow* meta_stack_get_bottom (MetaStack *stack); MetaWindow * meta_stack_get_bottom (MetaStack *stack);
/** /**
* meta_stack_get_above: * meta_stack_get_above:
@ -234,7 +234,7 @@ MetaWindow* meta_stack_get_bottom (MetaStack *stack);
* Returns: %NULL if there is no such window; * Returns: %NULL if there is no such window;
* the window above @window otherwise. * the window above @window otherwise.
*/ */
MetaWindow* meta_stack_get_above (MetaStack *stack, MetaWindow * meta_stack_get_above (MetaStack *stack,
MetaWindow *window, MetaWindow *window,
gboolean only_within_layer); gboolean only_within_layer);
@ -253,7 +253,7 @@ MetaWindow* meta_stack_get_above (MetaStack *stack,
* Returns: %NULL if there is no such window; * Returns: %NULL if there is no such window;
* the window below @window otherwise. * the window below @window otherwise.
*/ */
MetaWindow* meta_stack_get_below (MetaStack *stack, MetaWindow * meta_stack_get_below (MetaStack *stack,
MetaWindow *window, MetaWindow *window,
gboolean only_within_layer); gboolean only_within_layer);
@ -276,7 +276,7 @@ MetaWindow* meta_stack_get_below (MetaStack *stack,
* *
* Returns: The window matching all these constraints or %NULL if none does. * Returns: The window matching all these constraints or %NULL if none does.
*/ */
MetaWindow* meta_stack_get_default_focus_window (MetaStack *stack, MetaWindow * meta_stack_get_default_focus_window (MetaStack *stack,
MetaWorkspace *workspace, MetaWorkspace *workspace,
MetaWindow *not_this_one); MetaWindow *not_this_one);
@ -302,7 +302,7 @@ MetaWindow* meta_stack_get_default_focus_window (MetaStack *stack,
* *
* Returns: The window matching all these constraints or %NULL if none does. * Returns: The window matching all these constraints or %NULL if none does.
*/ */
MetaWindow* meta_stack_get_default_focus_window_at_point (MetaStack *stack, MetaWindow * meta_stack_get_default_focus_window_at_point (MetaStack *stack,
MetaWorkspace *workspace, MetaWorkspace *workspace,
MetaWindow *not_this_one, MetaWindow *not_this_one,
int root_x, int root_x,
@ -332,9 +332,10 @@ GList * meta_stack_get_default_focus_candidates (MetaStack *stack,
* *
* Finds all the windows in the stack, in order. * Finds all the windows in the stack, in order.
* *
* Returns: A list of windows, in stacking order, honouring layers. * Returns: (transfer container) (element-type Meta.Window):
* A list of windows, in stacking order, honouring layers.
*/ */
GList* meta_stack_list_windows (MetaStack *stack, GList * meta_stack_list_windows (MetaStack *stack,
MetaWorkspace *workspace); MetaWorkspace *workspace);
/** /**
@ -380,12 +381,13 @@ void meta_window_set_stack_position (MetaWindow *window,
* *
* Returns the current stack state, allowing rudimentary transactions. * Returns the current stack state, allowing rudimentary transactions.
* *
* Returns: An opaque GList representing the current stack sort order; * Returns: (transfer container) (element-type Meta.Window):
* An opaque #GList representing the current stack sort order;
* it is the caller's responsibility to free it. * it is the caller's responsibility to free it.
* Pass this to meta_stack_set_positions() later if you want to restore * Pass this to meta_stack_set_positions() later if you want to restore
* the state to where it was when you called this function. * the state to where it was when you called this function.
*/ */
GList* meta_stack_get_positions (MetaStack *stack); GList * meta_stack_get_positions (MetaStack *stack);
/** /**
* meta_stack_set_positions: * meta_stack_set_positions: