callisto-debian/gtk3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: use Returns: consistently

Browse Source 
Instead of Return value:
This commit is contained in:
William Jon McCann
2014-02-19 18:49:43 -05:00
parent a6084e264d
commit 469d333aa2
219 changed files with 1612 additions and 1612 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
gdk/x11/gdkcursor-x11.c
View File

@ -291,7 +291,7 @@ _gdk_x11_display_get_cursor_for_type (GdkDisplay *display,
*
* Returns the display of a #GdkCursor.
*
* Return value: (transfer none): an Xlib Display*.
* Returns: (transfer none): an Xlib Display*.
**/
Display *
gdk_x11_cursor_get_xdisplay (GdkCursor *cursor)
@ -307,7 +307,7 @@ gdk_x11_cursor_get_xdisplay (GdkCursor *cursor)
*
* Returns the X cursor belonging to a #GdkCursor.
*
* Return value: an Xlib Cursor.
* Returns: an Xlib Cursor.
**/
Cursor
gdk_x11_cursor_get_xcursor (GdkCursor *cursor)

6
gdk/x11/gdkdisplay-x11.c
View File

@ -1950,7 +1950,7 @@ gdk_x11_display_finalize (GObject *object)
*
* Find the #GdkDisplay corresponding to @xdisplay, if any exists.
*
* Return value: (transfer none) (type GdkX11Display): the #GdkDisplay, if found, otherwise %NULL.
* Returns: (transfer none) (type GdkX11Display): the #GdkDisplay, if found, otherwise %NULL.
*
* Since: 2.2
**/
@ -1986,7 +1986,7 @@ gdk_x11_lookup_xdisplay (Display *xdisplay)
* Given the root window ID of one of the screen’s of a #GdkDisplay,
* finds the screen.
*
* Return value: (transfer none): the #GdkScreen corresponding to
* Returns: (transfer none): the #GdkScreen corresponding to
* @xrootwin, or %NULL.
**/
GdkScreen *
@ -2751,7 +2751,7 @@ gdk_x11_display_set_window_scale (GdkDisplay *display,
*
* Since: 3.0
*
* Return value: X error code or 0 on success
* Returns: X error code or 0 on success
*/
gint
gdk_x11_display_error_trap_pop (GdkDisplay *display)

6
gdk/x11/gdkmain-x11.c
View File

@ -422,7 +422,7 @@ gdk_x11_ungrab_server (void)
*
* Gets the default GTK+ screen number.
*
* Return value: returns the screen number specified by
* Returns: returns the screen number specified by
* the --display command line option or the DISPLAY environment
* variable when gdk_init() calls XOpenDisplay().
**/
@ -438,7 +438,7 @@ gdk_x11_get_default_screen (void)
* Gets the root window of the default screen
* (see gdk_x11_get_default_screen()).
*
* Return value: an Xlib Window.
* Returns: an Xlib Window.
**/
Window
gdk_x11_get_default_root_xwindow (void)
@ -451,7 +451,7 @@ gdk_x11_get_default_root_xwindow (void)
*
* Gets the default GTK+ display.
*
* Return value: (transfer none): the Xlib Display* for
* Returns: (transfer none): the Xlib Display* for
* the display specified in the `--display` command
* line option or the `DISPLAY` environment variable.
**/

16
gdk/x11/gdkproperty-x11.c
View File

@ -175,7 +175,7 @@ lookup_cached_xatom (GdkDisplay *display,
* with the same string value. The special value %GDK_NONE
* is converted to %None.
*
* Return value: the X atom corresponding to @atom, or %None
* Returns: the X atom corresponding to @atom, or %None
*
* Since: 2.2
**/
@ -254,7 +254,7 @@ _gdk_x11_precache_atoms (GdkDisplay *display,
* Converts from a #GdkAtom to the X atom for the default GDK display
* with the same string value.
*
* Return value: the X atom corresponding to @atom.
* Returns: the X atom corresponding to @atom.
**/
Atom
gdk_x11_atom_to_xatom (GdkAtom atom)
@ -270,7 +270,7 @@ gdk_x11_atom_to_xatom (GdkAtom atom)
* Convert from an X atom for a #GdkDisplay to the corresponding
* #GdkAtom.
*
* Return value: (transfer none): the corresponding #GdkAtom.
* Returns: (transfer none): the corresponding #GdkAtom.
*
* Since: 2.2
**/
@ -329,7 +329,7 @@ gdk_x11_xatom_to_atom_for_display (GdkDisplay *display,
* Convert from an X atom for the default display to the corresponding
* #GdkAtom.
*
* Return value: (transfer none): the corresponding G#dkAtom.
* Returns: (transfer none): the corresponding G#dkAtom.
**/
GdkAtom
gdk_x11_xatom_to_atom (Atom xatom)
@ -346,7 +346,7 @@ gdk_x11_xatom_to_atom (Atom xatom)
* This function caches the result, so if called repeatedly it is much
* faster than XInternAtom(), which is a round trip to the server each time.
*
* Return value: a X atom for a #GdkDisplay
* Returns: a X atom for a #GdkDisplay
*
* Since: 2.2
**/
@ -387,7 +387,7 @@ _gdk_x11_get_xatom_for_display_printf (GdkDisplay *display,
* This function caches the result, so if called repeatedly it is much
* faster than XInternAtom(), which is a round trip to the server each time.
*
* Return value: a X atom for GDK’s default display.
* Returns: a X atom for GDK’s default display.
**/
Atom
gdk_x11_get_xatom_by_name (const gchar *atom_name)
@ -406,7 +406,7 @@ gdk_x11_get_xatom_by_name (const gchar *atom_name)
* XAtomName() and gdk_atom_name(), the result doesn’t need to
* be freed.
*
* Return value: name of the X atom; this string is owned by GDK,
* Returns: name of the X atom; this string is owned by GDK,
* so it shouldn’t be modifed or freed.
*
* Since: 2.2
@ -430,7 +430,7 @@ gdk_x11_get_xatom_name_for_display (GdkDisplay *display,
* doesn’t need to be freed. Also, this function will never return %NULL,
* even if @xatom is invalid.
*
* Return value: name of the X atom; this string is owned by GTK+,
* Returns: name of the X atom; this string is owned by GTK+,
* so it shouldn’t be modifed or freed.
**/
const gchar *

4
gdk/x11/gdkscreen-x11.c
View File

@ -1554,7 +1554,7 @@ fetch_net_wm_check_window (GdkScreen *screen)
* You can monitor the window_manager_changed signal on #GdkScreen to detect
* a window manager change.
*
* Return value: %TRUE if the window manager supports @property
* Returns: %TRUE if the window manager supports @property
*
* Since: 2.2
**/
@ -1635,7 +1635,7 @@ gdk_x11_screen_supports_net_wm_hint (GdkScreen *screen,
*
* Returns the name of the window manager for @screen.
*
* Return value: the name of the window manager screen @screen, or
* Returns: the name of the window manager screen @screen, or
* "unknown" if the window manager is unknown. The string is owned by GDK
* and should not be freed.
*

2
gdk/x11/gdkselection-x11.c
View File

@ -703,7 +703,7 @@ _gdk_x11_display_utf8_to_string_target (GdkDisplay *display,
*
* Converts from UTF-8 to compound text.
*
* Return value: %TRUE if the conversion succeeded,
* Returns: %TRUE if the conversion succeeded,
* otherwise %FALSE
*
* Since: 2.24

2
gdk/x11/gdkvisual-x11.c
View File

@ -583,7 +583,7 @@ _gdk_visual_get_x11_colormap (GdkVisual *visual)
*
* Returns the X visual belonging to a #GdkVisual.
*
* Return value: (transfer none): an Xlib Visual*.
* Returns: (transfer none): an Xlib Visual*.
**/
Visual *
gdk_x11_visual_get_xvisual (GdkVisual *visual)

6
gdk/x11/gdkwindow-x11.c
View File

@ -1185,7 +1185,7 @@ x_event_mask_to_gdk_event_mask (long mask)
* was already known to GDK, a new reference to the existing
* #GdkWindow is returned.
*
* Return value: (transfer full): a #GdkWindow wrapper for the native
* Returns: (transfer full): a #GdkWindow wrapper for the native
* window, or %NULL if the window has been destroyed. The wrapper
* will be newly created, if one doesn’t exist already.
*
@ -5485,7 +5485,7 @@ timestamp_predicate (Display *display,
*
* Routine to get the current X server time stamp.
*
* Return value: the time stamp.
* Returns: the time stamp.
**/
guint32
gdk_x11_get_server_time (GdkWindow *window)
@ -5521,7 +5521,7 @@ gdk_x11_get_server_time (GdkWindow *window)
*
* Returns the X resource (window) belonging to a #GdkWindow.
*
* Return value: the ID of @drawable’s X resource.
* Returns: the ID of @drawable’s X resource.
**/
XID
gdk_x11_window_get_xid (GdkWindow *window)

2
gdk/x11/gdkxid.c
View File

@ -85,7 +85,7 @@ _gdk_x11_display_remove_window (GdkDisplay *display,
*
* Looks up the #GdkWindow that wraps the given native window handle.
*
* Return value: (transfer none) (type GdkX11Window): the #GdkWindow wrapper for the native
* Returns: (transfer none) (type GdkX11Window): the #GdkWindow wrapper for the native
* window, or %NULL if there is none.
*
* Since: 2.24