diff options
author | Vincent Untz <vuntz@gnome.org> | 2010-08-04 13:28:31 +0200 |
---|---|---|
committer | Vincent Untz <vuntz@gnome.org> | 2010-08-04 13:28:31 +0200 |
commit | 46da208aa199806da2ffaaa641cba17e1dad0259 (patch) | |
tree | d7f5a2e54022cf10ef6e9bbf6577be75a25ea65d | |
parent | ac52bb7ccefed32699d80570cc83d40736635985 (diff) | |
download | libwnck-46da208aa199806da2ffaaa641cba17e1dad0259.tar.gz |
[screen] Wrap gtk-doc comments
-rw-r--r-- | libwnck/screen.c | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/libwnck/screen.c b/libwnck/screen.c index 8f6d5b9..5228d9a 100644 --- a/libwnck/screen.c +++ b/libwnck/screen.c @@ -617,9 +617,9 @@ wnck_screen_construct (WnckScreen *screen, * * Gets the #WnckScreen for a given screen on the default display. * - * 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. + * 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. **/ WnckScreen* wnck_screen_get (int index) @@ -662,8 +662,8 @@ _wnck_screen_get_existing (int number) * * Gets the default #WnckScreen on the default display. * - * Return value: (transfer none): the default #WnckScreen. The returned #WnckScreen is - * owned by libwnck and must not be referenced or unreferenced. + * Return value: (transfer none): the default #WnckScreen. The returned + * #WnckScreen is owned by libwnck and must not be referenced or unreferenced. **/ WnckScreen* wnck_screen_get_default (void) @@ -685,9 +685,9 @@ 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: (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. + * 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. **/ WnckScreen* wnck_screen_get_for_root (gulong root_window_id) @@ -735,8 +735,9 @@ 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: (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. + * 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,9 +756,9 @@ wnck_screen_get_workspaces (WnckScreen *screen) * * Gets the #WnckWorkspace numbered @workspace on @screen. * - * 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. + * 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. **/ WnckWorkspace* wnck_screen_get_workspace (WnckScreen *screen, @@ -822,9 +823,9 @@ 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: (transfer none): the active #WnckWorkspace on @screen, or %NULL. The returned - * #WnckWorkspace is owned by libwnck and must not be referenced or - * unreferenced. + * 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. **/ WnckWorkspace* wnck_screen_get_active_workspace (WnckScreen *screen) @@ -950,9 +951,9 @@ 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: (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. + * 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. **/ GList* wnck_screen_get_windows (WnckScreen *screen) |