diff options
author | Tomeu Vizoso <tomeu.vizoso@collabora.co.uk> | 2010-07-29 12:00:46 +0200 |
---|---|---|
committer | Tomeu Vizoso <tomeu.vizoso@collabora.co.uk> | 2010-07-29 12:00:46 +0200 |
commit | ac52bb7ccefed32699d80570cc83d40736635985 (patch) | |
tree | 23544558027502a199239032756784e3f4f0783e | |
parent | ea10769e72dba719cfaec67bc8331e7a428cbabe (diff) | |
download | libwnck-ac52bb7ccefed32699d80570cc83d40736635985.tar.gz |
Add introspection annotations
-rw-r--r-- | libwnck/application.c | 13 | ||||
-rw-r--r-- | libwnck/class-group.c | 15 | ||||
-rw-r--r-- | libwnck/screen.c | 42 | ||||
-rw-r--r-- | libwnck/window.c | 26 |
4 files changed, 50 insertions, 46 deletions
diff --git a/libwnck/application.c b/libwnck/application.c index 5679298..1506417 100644 --- a/libwnck/application.c +++ b/libwnck/application.c @@ -208,9 +208,10 @@ wnck_application_finalize (GObject *object) * Gets the #WnckApplication corresponding to the group leader with @xwindow * as X window ID. * - * Return value: the #WnckApplication corresponding to @xwindow, or %NULL if - * there no such #WnckApplication could be found. The returned #WnckApplication - * is owned by libwnck and must not be referenced or unreferenced. + * Return value: (transfer none): the #WnckApplication corresponding to + * @xwindow, or %NULL if there no such #WnckApplication could be found. The + * returned #WnckApplication is owned by libwnck and must not be referenced or + * unreferenced. */ WnckApplication* wnck_application_get (gulong xwindow) @@ -243,9 +244,9 @@ wnck_application_get_xid (WnckApplication *app) * * Gets the list of #WnckWindow belonging to @app. * - * Return value: the list of #WnckWindow belonging to @app, or %NULL if the - * application contains no window. The list should not be modified nor freed, - * as it is owned by @app. + * Return value: (element-type WnckWindow) (transfer none): the list of + * #WnckWindow belonging to @app, or %NULL if the application contains no + * window. The list should not be modified nor freed, as it is owned by @app. **/ GList* wnck_application_get_windows (WnckApplication *app) diff --git a/libwnck/class-group.c b/libwnck/class-group.c index 50a9ef8..14a0205 100644 --- a/libwnck/class-group.c +++ b/libwnck/class-group.c @@ -165,10 +165,10 @@ wnck_class_group_finalize (GObject *object) * * Gets the #WnckClassGroup corresponding to @res_class. * - * Return value: the #WnckClassGroup corresponding to @res_class, or %NULL if - * there is no #WnckClassGroup with the specified @res_class. The returned - * #WnckClassGroup is owned by libwnck and must not be referenced or - * unreferenced. + * Return value: (transfer none): the #WnckClassGroup corresponding to + * @res_class, or %NULL if there is no #WnckClassGroup with the specified + * @res_class. The returned #WnckClassGroup is owned by libwnck and must not be + * referenced or unreferenced. * * Since: 2.2 **/ @@ -500,9 +500,10 @@ _wnck_class_group_remove_window (WnckClassGroup *class_group, * * Gets the list of #WnckWindow that are grouped in @class_group. * - * Return value: the list of #WnckWindow grouped in @class_group, or %NULL if - * the group contains no window. The list should not be modified nor freed, as - * it is owned by @class_group. + * Return value: (element-type WnckWindow) (transfer none): the list of + * #WnckWindow grouped in @class_group, or %NULL if the group contains no + * window. The list should not be modified nor freed, as it is owned by + * @class_group. * * Since: 2.2 **/ diff --git a/libwnck/screen.c b/libwnck/screen.c index db25cce..8f6d5b9 100644 --- a/libwnck/screen.c +++ b/libwnck/screen.c @@ -617,7 +617,7 @@ wnck_screen_construct (WnckScreen *screen, * * Gets the #WnckScreen for a given screen on the default display. * - * Return value: the #WnckScreen for screen @index, or %NULL if no such screen + * Return value: (transfer none): the #WnckScreen for screen @index, or %NULL if no such screen * exists. The returned #WnckScreen is owned by libwnck and must not be * referenced or unreferenced. **/ @@ -662,7 +662,7 @@ _wnck_screen_get_existing (int number) * * Gets the default #WnckScreen on the default display. * - * Return value: the default #WnckScreen. The returned #WnckScreen is + * Return value: (transfer none): the default #WnckScreen. The returned #WnckScreen is * owned by libwnck and must not be referenced or unreferenced. **/ WnckScreen* @@ -685,7 +685,7 @@ wnck_screen_get_default (void) * This function does not work if wnck_screen_get() was not called for the * sought #WnckScreen before, and returns %NULL. * - * Return value: the #WnckScreen for the root window at @root_window_id, or + * Return value: (transfer none): the #WnckScreen for the root window at @root_window_id, or * %NULL. The returned #WnckScreen is owned by libwnck and must not be * referenced or unreferenced. **/ @@ -735,8 +735,8 @@ wnck_screen_get_number (WnckScreen *screen) * Gets the list of #WnckWorkspace on @screen. The list is ordered: the * first element in the list is the first #WnckWorkspace, etc.. * - * Return value: the list of #WnckWorkspace on @screen. The list should not be - * modified nor freed, as it is owned by @screen. + * Return value: (element-type WnckWorkspace) (transfer none): the list of #WnckWorkspace on @screen. The + * list should not be modified nor freed, as it is owned by @screen. * * Since: 2.20 **/ @@ -755,7 +755,7 @@ wnck_screen_get_workspaces (WnckScreen *screen) * * Gets the #WnckWorkspace numbered @workspace on @screen. * - * Return value: the #WnckWorkspace numbered @workspace on @screen, or + * Return value: (transfer none): the #WnckWorkspace numbered @workspace on @screen, or * %NULL if no such workspace exists. The returned #WnckWorkspace is owned by * libwnck and must not be referenced or unreferenced. **/ @@ -822,7 +822,7 @@ wnck_screen_get_workspace_index (WnckScreen *screen, * if libwnck is in a weird state due to the asynchronous nature of the * interaction with the window manager. * - * Return value: the active #WnckWorkspace on @screen, or %NULL. The returned + * Return value: (transfer none): the active #WnckWorkspace on @screen, or %NULL. The returned * #WnckWorkspace is owned by libwnck and must not be referenced or * unreferenced. **/ @@ -843,10 +843,10 @@ wnck_screen_get_active_workspace (WnckScreen *screen) * Gets the neighbor #WnckWorkspace of @space in the @direction direction on * @screen. * - * Return value: the neighbor #WnckWorkspace of @space in the @direction - * direction on @screen, or %NULL if no such neighbor #WnckWorkspace exists. - * The returned #WnckWorkspace is owned by libwnck and must not be referenced - * or unreferenced. + * Return value: (transfer none): the neighbor #WnckWorkspace of @space in the + * @direction direction on @screen, or %NULL if no such neighbor #WnckWorkspace + * exists. The returned #WnckWorkspace is owned by libwnck and must not be + * referenced or unreferenced. * * Since: 2.14 * Deprecated:2.20: Use wnck_workspace_get_neighbor() instead. @@ -907,8 +907,9 @@ wnck_screen_get_workspace_neighbor (WnckScreen *screen, * Gets the active #WnckWindow on @screen. May return %NULL sometimes, since * not all window managers guarantee that a window is always active. * - * Return value: the active #WnckWindow on @screen, or %NULL. The returned - * #WnckWindow is owned by libwnck and must not be referenced or unreferenced. + * Return value: (transfer none): the active #WnckWindow on @screen, or %NULL. + * The returned #WnckWindow is owned by libwnck and must not be referenced or + * unreferenced. **/ WnckWindow* wnck_screen_get_active_window (WnckScreen *screen) @@ -926,9 +927,9 @@ wnck_screen_get_active_window (WnckScreen *screen) * sometimes, since not all window managers guarantee that a window is always * active. * - * Return value: the previously active #WnckWindow on @screen, or %NULL. The - * returned #WnckWindow is owned by libwnck and must not be referenced or - * unreferenced. + * Return value: (transfer none): the previously active #WnckWindow on @screen, + * or %NULL. The returned #WnckWindow is owned by libwnck and must not be + * referenced or unreferenced. * * Since: 2.8 **/ @@ -949,7 +950,7 @@ wnck_screen_get_previously_active_window (WnckScreen *screen) * However, the stability of the list is established by the window manager, so * don't blame libwnck if it breaks down. * - * Return value: the list of #WnckWindow on @screen, or %NULL if there is no + * Return value: (element-type WnckWindow) (transfer none): the list of #WnckWindow on @screen, or %NULL if there is no * window on @screen. The list should not be modified nor freed, as it is owned * by @screen. **/ @@ -967,9 +968,10 @@ wnck_screen_get_windows (WnckScreen *screen) * * Gets the list of #WnckWindow on @screen in bottom-to-top order. * - * Return value: the list of #WnckWindow in stacking order on @screen, or %NULL - * if there is no window on @screen. The list should not be modified nor freed, - * as it is owned by @screen. + * Return value: (element-type WnckWindow) (transfer none): the list of + * #WnckWindow in stacking order on @screen, or %NULL if there is no window on + * @screen. The list should not be modified nor freed, as it is owned by + * @screen. **/ GList* wnck_screen_get_windows_stacked (WnckScreen *screen) diff --git a/libwnck/window.c b/libwnck/window.c index 50bad36..30f8eb0 100644 --- a/libwnck/window.c +++ b/libwnck/window.c @@ -464,8 +464,8 @@ wnck_window_finalize (GObject *object) * create a #WnckWindow if none exists. The function is robust against bogus * window IDs. * - * Return value: the #WnckWindow for @xwindow. The returned #WnckWindow is - * owned by libwnck and must not be referenced or unreferenced. + * Return value: (transfer none): the #WnckWindow for @xwindow. The returned + * #WnckWindow is owned by libwnck and must not be referenced or unreferenced. **/ WnckWindow* wnck_window_get (gulong xwindow) @@ -482,8 +482,8 @@ wnck_window_get (gulong xwindow) * * Gets the #WnckScreen @window is on. * - * Return value: the #WnckScreen @window is on. The returned #WnckScreen is - * owned by libwnck and must not be referenced or unreferenced. + * Return value: (transfer none): the #WnckScreen @window is on. The returned + * #WnckScreen is owned by libwnck and must not be referenced or unreferenced. **/ WnckScreen* wnck_window_get_screen (WnckWindow *window) @@ -718,9 +718,9 @@ _wnck_window_get_name_for_display (WnckWindow *window, * * Gets the #WnckApplication to which @window belongs. * - * Return value: the #WnckApplication to which @window belongs. The returned - * #WnckApplication is owned by libwnck and must not be referenced or - * unreferenced. + * Return value: (transfer none): the #WnckApplication to which @window belongs. + * The returned #WnckApplication is owned by libwnck and must not be referenced + * or unreferenced. **/ WnckApplication* wnck_window_get_application (WnckWindow *window) @@ -789,9 +789,9 @@ wnck_window_get_xid (WnckWindow *window) * * Gets the #WnckClassGroup to which @window belongs. * - * Return value: the #WnckClassGroup to which @window belongs. The returned - * #WnckClassGroup is owned by libwnck and must not be referenced or - * unreferenced. + * Return value: (transfer none): the #WnckClassGroup to which @window belongs. + * The returned #WnckClassGroup is owned by libwnck and must not be referenced + * or unreferenced. * * Since: 2.2 **/ @@ -1749,9 +1749,9 @@ wnck_window_keyboard_size (WnckWindow *window) * Gets the current workspace @window is on. If the window is pinned (on all * workspaces), or not on any workspaces, %NULL may be returned. * - * Return value: the single current workspace @window is on, or %NULL. The - * returned #WnckWorkspace is owned by libwnck and must not be referenced or - * unreferenced. + * Return value: (transfer none): the single current workspace @window is on, or + * %NULL. The returned #WnckWorkspace is owned by libwnck and must not be + * referenced or unreferenced. **/ WnckWorkspace* wnck_window_get_workspace (WnckWindow *window) |