Commit 8ba16eb4 authored by Matthias Clasen's avatar Matthias Clasen
Browse files

Documentation fixes

Mostly fixing up indentation of continuation lines,
and other small cleanups.
parent ab6a5be0
......@@ -504,8 +504,8 @@ gdk_clipboard_is_local (GdkClipboard *clipboard)
* If the @clipboard is empty or its contents are not owned by the
* current process, %NULL will be returned.
*
* Returns: (transfer none) (nullable): The content of a clipboard or %NULL
* if the clipboard does not maintain any content.
* Returns: (transfer none) (nullable): The content of a clipboard
* if the clipboard does not maintain any content
*/
GdkContentProvider *
gdk_clipboard_get_content (GdkClipboard *clipboard)
......@@ -677,14 +677,14 @@ gdk_clipboard_read_async (GdkClipboard *clipboard,
* @clipboard: a `GdkClipboard`
* @result: a `GAsyncResult`
* @out_mime_type: (out) (allow-none) (transfer none): pointer to store
* the chosen mime type in or %NULL
* @error: a `GError` location to store the error occurring, or %NULL to ignore.
* the chosen mime type
* @error: a `GError` location to store the error occurring
*
* Finishes an asynchronous clipboard read.
*
* See [method@Gdk.Clipboard.read_async].
*
* Returns: (transfer full) (nullable): a `GInputStream` or %NULL on error.
* Returns: (transfer full) (nullable): a `GInputStream` or %NULL on error
*/
GInputStream *
gdk_clipboard_read_finish (GdkClipboard *clipboard,
......@@ -1194,8 +1194,8 @@ gdk_clipboard_claim_remote (GdkClipboard *clipboard,
/**
* gdk_clipboard_set_content:
* @clipboard: a `GdkClipboard`
* @provider: (transfer none) (allow-none): the new contents of @clipboard or
* %NULL to clear the clipboard
* @provider: (transfer none) (allow-none): the new contents of @clipboard
* or %NULL to clear the clipboard
*
* Sets a new content provider on @clipboard.
*
......
......@@ -85,7 +85,7 @@ G_DEFINE_BOXED_TYPE (GdkContentFormats, gdk_content_formats,
* See RFC 2048 for the syntax if mime types.
*
* Returns: An interned string for the canonicalized mime type
* or %NULL if the string wasn't a valid mime type
* or %NULL if the string wasn't a valid mime type
*/
const char *
gdk_intern_mime_type (const char *string)
......@@ -454,16 +454,15 @@ gdk_content_formats_contain_mime_type (const GdkContentFormats *formats,
* gdk_content_formats_get_gtypes:
* @formats: a `GdkContentFormats`
* @n_gtypes: (out) (optional): optional pointer to take the
* number of #GTypes contained in the return value
* number of `GType`s contained in the return value
*
* Gets the `GTypes` included in @formats.
* Gets the `GType`s included in @formats.
*
* Note that @formats may not contain any #GTypes, in particular when
* they are empty. In that case %NULL will be returned.
*
* Returns: (transfer none) (nullable) (array length=n_gtypes zero-terminated=1):
* %G_TYPE_INVALID-terminated array of types included in @formats or
* %NULL if none.
* %G_TYPE_INVALID-terminated array of types included in @formats
*/
const GType *
gdk_content_formats_get_gtypes (const GdkContentFormats *formats,
......@@ -481,16 +480,16 @@ gdk_content_formats_get_gtypes (const GdkContentFormats *formats,
* gdk_content_formats_get_mime_types:
* @formats: a `GdkContentFormats`
* @n_mime_types: (out) (optional): optional pointer to take the
* number of mime types contained in the return value
* number of mime types contained in the return value
*
* Gets the mime types included in @formats.
*
* Note that @formats may not contain any mime types, in particular
* when they are empty. In that case %NULL will be returned.
*
* Returns: (transfer none) (nullable) (array length=n_mime_types zero-terminated=1): %NULL-terminated array of
* interned strings of mime types included in @formats or %NULL
* if none.
* Returns: (transfer none) (nullable) (array length=n_mime_types zero-terminated=1):
* %NULL-terminated array of interned strings of mime types included
* in @formats
*/
const char * const *
gdk_content_formats_get_mime_types (const GdkContentFormats *formats,
......
......@@ -326,7 +326,7 @@ gdk_content_provider_write_mime_type_async (GdkContentProvider *provider,
* See [method@Gdk.ContentProvider.write_mime_type_async].
*
* Returns: %TRUE if the operation was completed successfully. Otherwise
* @error will be set to describe the failure.
* @error will be set to describe the failure.
*/
gboolean
gdk_content_provider_write_mime_type_finish (GdkContentProvider *provider,
......@@ -354,7 +354,7 @@ gdk_content_provider_write_mime_type_finish (GdkContentProvider *provider,
* #G_IO_ERROR_NOT_SUPPORTED will be reported.
*
* Returns: %TRUE if the value was set successfully. Otherwise
* @error will be set to describe the failure.
* @error will be set to describe the failure.
*/
gboolean
gdk_content_provider_get_value (GdkContentProvider *provider,
......
......@@ -394,7 +394,7 @@ gdk_content_provider_union_init (GdkContentProviderUnion *self)
/**
* gdk_content_provider_new_union:
* @providers: (nullable) (array length=n_providers) (transfer full):
* The #GdkContentProviders to present the union of
* The #GdkContentProviders to present the union of
* @n_providers: the number of providers
*
* Creates a content provider that represents all the given @providers.
......
......@@ -299,7 +299,7 @@ gdk_cursor_equal (gconstpointer a,
* gdk_cursor_new_from_name:
* @name: the name of the cursor
* @fallback: (allow-none): %NULL or the `GdkCursor` to fall back to when
* this one cannot be supported
* this one cannot be supported
*
* Creates a new cursor by looking up @name in the current cursor
* theme.
......@@ -341,7 +341,7 @@ gdk_cursor_new_from_name (const char *name,
* @hotspot_x: the horizontal offset of the “hotspot” of the cursor
* @hotspot_y: the vertical offset of the “hotspot” of the cursor
* @fallback: (allow-none): %NULL or the `GdkCursor` to fall back to when
* this one cannot be supported
* this one cannot be supported
*
* Creates a new cursor from a `GdkTexture`.
*
......
......@@ -520,19 +520,19 @@ gdk_device_get_property (GObject *object,
/**
* gdk_device_get_surface_at_position:
* @device: pointer `GdkDevice` to query info to
* @win_x: (out) (allow-none): return location for the X coordinate of the device location,
* relative to the surface origin, or %NULL.
* @win_y: (out) (allow-none): return location for the Y coordinate of the device location,
* relative to the surface origin, or %NULL.
* @win_x: (out) (allow-none): return location for the X coordinate
* of the device location relative to the surface origin
* @win_y: (out) (allow-none): return location for the Y coordinate
* of the device location relative to the surface origin
*
* Obtains the surface underneath @device, returning the location of the
* device in @win_x and @win_y
* device in @win_x and @win_y.
*
* Returns %NULL if the surface tree under @device is not known to GDK
* (for example, belongs to another application).
*
* Returns: (nullable) (transfer none): the `GdkSurface` under the
* device position, or %NULL
* device position
*/
GdkSurface *
gdk_device_get_surface_at_position (GdkDevice *device,
......@@ -1368,8 +1368,7 @@ gdk_device_get_direction (GdkDevice *device)
*
* This is only relevant for keyboard devices.
*
* Returns: %TRUE if there are layouts with both directions,
* %FALSE otherwise
* Returns: %TRUE if there are layouts with both directions, %FALSE otherwise
*/
gboolean
gdk_device_has_bidi_layouts (GdkDevice *device)
......
......@@ -38,16 +38,16 @@ typedef struct _GdkTimeCoord GdkTimeCoord;
/**
* GdkInputSource:
* @GDK_SOURCE_MOUSE: the device is a mouse. (This will be reported for the core
* pointer, even if it is something else, such as a trackball.)
* pointer, even if it is something else, such as a trackball.)
* @GDK_SOURCE_PEN: the device is a stylus of a graphics tablet or similar device.
* @GDK_SOURCE_KEYBOARD: the device is a keyboard.
* @GDK_SOURCE_TOUCHSCREEN: the device is a direct-input touch device, such
* as a touchscreen or tablet
* as a touchscreen or tablet
* @GDK_SOURCE_TOUCHPAD: the device is an indirect touch device, such
* as a touchpad
* as a touchpad
* @GDK_SOURCE_TRACKPOINT: the device is a trackpoint
* @GDK_SOURCE_TABLET_PAD: the device is a "pad", a collection of buttons,
* rings and strips found in drawing tablets
* rings and strips found in drawing tablets
*
* An enumeration describing the type of an input device in general terms.
*/
......
......@@ -1036,8 +1036,7 @@ gdk_display_real_get_app_launch_context (GdkDisplay *display)
* Returns a `GdkAppLaunchContext` suitable for launching
* applications on the given display.
*
* Returns: (transfer full): a new `GdkAppLaunchContext` for @display.
* Free with g_object_unref() when done
* Returns: (transfer full): a new `GdkAppLaunchContext` for @display
*/
GdkAppLaunchContext *
gdk_display_get_app_launch_context (GdkDisplay *display)
......@@ -1053,8 +1052,9 @@ gdk_display_get_app_launch_context (GdkDisplay *display)
*
* Opens a display.
*
* Returns: (nullable) (transfer none): a `GdkDisplay`, or %NULL if the
* display could not be opened
* If opening the display fails, `NULL` is returned.
*
* Returns: (nullable) (transfer none): a `GdkDisplay`
*/
GdkDisplay *
gdk_display_open (const char *display_name)
......@@ -1073,7 +1073,7 @@ _gdk_display_get_next_serial (GdkDisplay *display)
* gdk_display_notify_startup_complete:
* @display: a `GdkDisplay`
* @startup_id: a startup-notification identifier, for which
* notification process should be completed
* notification process should be completed
*
* Indicates to the GUI environment that the application has
* finished loading, using a given identifier.
......@@ -1099,7 +1099,7 @@ gdk_display_notify_startup_complete (GdkDisplay *display,
* Gets the startup notification ID for a Wayland display, or %NULL
* if no ID has been defined.
*
* Returns: (nullable): the startup notification ID for @display, or %NULL
* Returns: (nullable): the startup notification ID for @display
*/
const char *
gdk_display_get_startup_notification_id (GdkDisplay *display)
......@@ -1160,7 +1160,7 @@ gdk_display_get_keymap (GdkDisplay *display)
/*< private >
* gdk_display_make_gl_context_current:
* @display: a #GdkDisplay
* @context: (optional): a #GdkGLContext, or %NULL
* @context: (optional): a #GdkGLContext
*
* Makes the given @context the current GL context, or unsets
* the current GL context if @context is %NULL.
......@@ -1243,7 +1243,7 @@ gdk_display_set_composited (GdkDisplay *display,
* On modern displays, this value is always %TRUE.
*
* Returns: %TRUE if surfaces are created with an alpha channel or
* %FALSE if the display does not support this functionality.
* %FALSE if the display does not support this functionality.
*/
gboolean
gdk_display_is_rgba (GdkDisplay *display)
......@@ -1343,8 +1343,8 @@ gdk_display_get_default_seat (GdkDisplay *display)
* Returns the list of seats known to @display.
*
* Returns: (transfer container) (element-type GdkSeat): the
* list of seats known to the `GdkDisplay`
**/
* list of seats known to the `GdkDisplay`
*/
GList *
gdk_display_list_seats (GdkDisplay *display)
{
......@@ -1502,7 +1502,7 @@ gdk_display_set_cursor_theme (GdkDisplay *display,
* @display: a `GdkDisplay`
* @keyval: a keyval, such as %GDK_KEY_a, %GDK_KEY_Up, %GDK_KEY_Return, etc.
* @keys: (out) (array length=n_keys) (transfer full): return location
* for an array of `GdkKeymapKey`
* for an array of `GdkKeymapKey`
* @n_keys: return location for number of elements in returned array
*
* Obtains a list of keycode/group/level combinations that will
......@@ -1540,9 +1540,9 @@ gdk_display_map_keyval (GdkDisplay *display,
* @display: a `GdkDisplay`
* @keycode: a keycode
* @keys: (out) (array length=n_entries) (transfer full) (optional): return
* location for array of `GdkKeymapKey`, or %NULL
* location for array of `GdkKeymapKey`
* @keyvals: (out) (array length=n_entries) (transfer full) (optional): return
* location for array of keyvals, or %NULL
* location for array of keyvals
* @n_entries: length of @keys and @keyvals
*
* Returns the keyvals bound to @keycode.
......@@ -1577,12 +1577,11 @@ gdk_display_map_keycode (GdkDisplay *display,
* @keycode: a keycode
* @state: a modifier state
* @group: active keyboard group
* @keyval: (out) (optional): return location for keyval, or %NULL
* @effective_group: (out) (optional): return location for effective
* group, or %NULL
* @level: (out) (optional): return location for level, or %NULL
* @consumed: (out) (optional): return location for modifiers
* that were used to determine the group or level, or %NULL
* @keyval: (out) (optional): return location for keyval
* @effective_group: (out) (optional): return location for effective group
* @level: (out) (optional): return location for level
* @consumed: (out) (optional): return location for modifiers that were used
* to determine the group or level
*
* Translates the contents of a `GdkEventKey` into a keyval, effective group,
* and level.
......
......@@ -309,8 +309,7 @@ gdk_display_manager_get (void)
*
* Gets the default `GdkDisplay`.
*
* Returns: (nullable) (transfer none): a `GdkDisplay`, or %NULL if
* there is no default display.
* Returns: (nullable) (transfer none): a `GdkDisplay`
*/
GdkDisplay *
gdk_display_manager_get_default_display (GdkDisplayManager *manager)
......@@ -361,8 +360,7 @@ gdk_display_manager_set_default_display (GdkDisplayManager *manager,
* List all currently open displays.
*
* Returns: (transfer container) (element-type GdkDisplay): a newly
* allocated `GSList` of `GdkDisplay` objects. Free with g_slist_free()
* when you are done with it.
* allocated `GSList` of `GdkDisplay` objects
*/
GSList *
gdk_display_manager_list_displays (GdkDisplayManager *manager)
......
......@@ -188,7 +188,7 @@ gdk_draw_context_init (GdkDrawContext *self)
* may be effecting the contents of the @context's surface.
*
* Returns: %TRUE if the context is between [method@Gdk.DrawContext.begin_frame]
* and [method@Gdk.DrawContext.end_frame] calls.
* and [method@Gdk.DrawContext.end_frame] calls.
*/
gboolean
gdk_draw_context_is_in_frame (GdkDrawContext *context)
......@@ -393,8 +393,7 @@ gdk_draw_context_end_frame (GdkDrawContext *context)
* If @context is not in between calls to [method@Gdk.DrawContext.begin_frame]
* and [method@Gdk.DrawContext.end_frame], %NULL will be returned.
*
* Returns: (transfer none) (nullable): a Cairo region or %NULL if not drawing
* a frame.
* Returns: (transfer none) (nullable): a Cairo region
*/
const cairo_region_t *
gdk_draw_context_get_frame_region (GdkDrawContext *context)
......
......@@ -657,12 +657,11 @@ gdk_drop_read_internal (GdkDrop *self,
* gdk_drop_read_async:
* @self: a `GdkDrop`
* @mime_types: (array zero-terminated=1) (element-type utf8):
* pointer to an array of mime types
* pointer to an array of mime types
* @io_priority: the I/O priority for the read operation
* @cancellable: (allow-none): optional `GCancellable` object,
* %NULL to ignore
* @cancellable: (allow-none): optional `GCancellable` object
* @callback: (scope async): a `GAsyncReadyCallback` to call when
* the request is satisfied
* the request is satisfied
* @user_data: (closure): the data to pass to @callback
*
* Asynchronously read the dropped data from a `GdkDrop`
......
......@@ -491,7 +491,7 @@ gboolean gdk_events_get_center (GdkEvent *event1,
* GdkKeyMatch:
* @GDK_KEY_MATCH_NONE: The key event does not match
* @GDK_KEY_MATCH_PARTIAL: The key event matches if keyboard state
* (specifically, the currently active group) is ignored
* (specifically, the currently active group) is ignored
* @GDK_KEY_MATCH_EXACT: The key event matches
*
* Describes how well an event matches a given keyval and modifiers.
......
......@@ -412,7 +412,7 @@ gdk_keymap_get_modifier_state (GdkKeymap *keymap)
* @keymap: a #GdkKeymap
* @keyval: a keyval, such as %GDK_KEY_a, %GDK_KEY_Up, %GDK_KEY_Return, etc.
* @keys: (out) (array length=n_keys) (transfer full): return location
* for an array of #GdkKeymapKey
* for an array of #GdkKeymapKey
* @n_keys: return location for number of elements in returned array
*
* Obtains a list of keycode/group/level combinations that will
......@@ -494,9 +494,9 @@ gdk_keymap_get_cached_entries_for_keyval (GdkKeymap *keymap,
* @keymap: a #GdkKeymap
* @hardware_keycode: a keycode
* @keys: (out) (array length=n_entries) (transfer full) (optional): return
* location for array of #GdkKeymapKey, or %NULL
* location for array of #GdkKeymapKey
* @keyvals: (out) (array length=n_entries) (transfer full) (optional): return
* location for array of keyvals, or %NULL
* location for array of keyvals
* @n_entries: length of @keys and @keyvals
*
* Returns the keyvals bound to @hardware_keycode.
......@@ -551,12 +551,11 @@ gdk_keymap_lookup_key (GdkKeymap *keymap,
* @hardware_keycode: a keycode
* @state: a modifier state
* @group: active keyboard group
* @keyval: (out) (allow-none): return location for keyval, or %NULL
* @effective_group: (out) (allow-none): return location for effective
* group, or %NULL
* @level: (out) (allow-none): return location for level, or %NULL
* @keyval: (out) (allow-none): return location for keyval
* @effective_group: (out) (allow-none): return location for effective group
* @level: (out) (allow-none): return location for level
* @consumed_modifiers: (out) (allow-none): return location for modifiers
* that were used to determine the group or level, or %NULL
* that were used to determine the group or level
*
* Translates the contents of a #GdkEventKey into a keyval, effective
* group, and level. Modifiers that affected the translation and
......@@ -646,8 +645,7 @@ gdk_keymap_translate_keyboard_state (GdkKeymap *keymap,
* but without the leading “GDK_KEY_”.
*
* Returns: (nullable) (transfer none): a string containing the name
* of the key, or %NULL if @keyval is not a valid key. The string
* should not be modified.
* of the key
*/
const char *
gdk_keyval_name (guint keyval)
......@@ -666,7 +664,7 @@ gdk_keyval_name (guint keyval)
* but without the leading “GDK_KEY_”.
*
* Returns: the corresponding key value, or %GDK_KEY_VoidSymbol
* if the key name is not a valid key
* if the key name is not a valid key
*/
guint
gdk_keyval_from_name (const char *keyval_name)
......
......@@ -31,11 +31,11 @@ G_BEGIN_DECLS
/**
* GdkMemoryFormat:
* @GDK_MEMORY_B8G8R8A8_PREMULTIPLIED: 4 bytes; for blue, green, red, alpha.
* The color values are premultiplied with the alpha value.
* The color values are premultiplied with the alpha value.
* @GDK_MEMORY_A8R8G8B8_PREMULTIPLIED: 4 bytes; for alpha, red, green, blue.
* The color values are premultiplied with the alpha value.
* The color values are premultiplied with the alpha value.
* @GDK_MEMORY_R8G8B8A8_PREMULTIPLIED: 4 bytes; for red, green, blue, alpha
* The color values are premultiplied with the alpha value.
* The color values are premultiplied with the alpha value.
* @GDK_MEMORY_B8G8R8A8: 4 bytes; for blue, green, red, alpha.
* @GDK_MEMORY_A8R8G8B8: 4 bytes; for alpha, red, green, blue.
* @GDK_MEMORY_R8G8B8A8: 4 bytes; for red, green, blue, alpha.
......@@ -43,7 +43,7 @@ G_BEGIN_DECLS
* @GDK_MEMORY_R8G8B8: 3 bytes; for red, green, blue. The data is opaque.
* @GDK_MEMORY_B8G8R8: 3 bytes; for blue, green, red. The data is opaque.
* @GDK_MEMORY_N_FORMATS: The number of formats. This value will change as
* more formats get added, so do not rely on its concrete integer.
* more formats get added, so do not rely on its concrete integer.
*
* `GdkMemoryFormat` describes a format that bytes can have in memory.
*
......
......@@ -257,7 +257,7 @@ gdk_paintable_is_immutable (GdkPaintable *paintable)
* If the @paintable is already immutable, it will return itself.
*
* Returns: (transfer full): An immutable paintable for the current
* contents of @paintable.
* contents of @paintable
*/
GdkPaintable *
gdk_paintable_get_current_image (GdkPaintable *paintable)
......@@ -439,17 +439,15 @@ gdk_paintable_invalidate_size (GdkPaintable *paintable)
* gdk_paintable_compute_concrete_size:
* @paintable: a `GdkPaintable`
* @specified_width: the width @paintable could be drawn into or
* 0.0 if unknown
* 0.0 if unknown
* @specified_height: the height @paintable could be drawn into or
* 0.0 if unknown
* 0.0 if unknown
* @default_width: the width @paintable would be drawn into if
* no other constraints were given
* no other constraints were given
* @default_height: the height @paintable would be drawn into if
* no other constraints were given
* @concrete_width: (out): will be set to the concrete width
* computed.
* @concrete_height: (out): will be set to the concrete height
* computed.
* no other constraints were given
* @concrete_width: (out): will be set to the concrete width computed
* @concrete_height: (out): will be set to the concrete height computed
*
* Compute a concrete size for the `GdkPaintable`.
*
......
......@@ -37,11 +37,11 @@ G_DECLARE_INTERFACE (GdkPaintable, gdk_paintable, GDK, PAINTABLE, GObject)
/**
* GdkPaintableFlags:
* @GDK_PAINTABLE_STATIC_SIZE: The size is immutable.
* The [signal@GdkPaintable::invalidate-size] signal will never be
* emitted.
* The [signal@GdkPaintable::invalidate-size] signal will never be
* emitted.
* @GDK_PAINTABLE_STATIC_CONTENTS: The content is immutable.
* The [signal@GdkPaintable::invalidate-contents] signal will never be
* emitted.
* The [signal@GdkPaintable::invalidate-contents] signal will never be
* emitted.
*
* Flags about a paintable object.
*
......@@ -55,31 +55,31 @@ typedef enum {
/**
* GdkPaintableInterface:
* @snapshot: Snapshot the paintable. The given @width and @height are
* guaranteed to be larger than 0.0. The resulting snapshot must modify
* only the area in the rectangle from (0,0) to (width, height).
* This is the only function that must be implemented for this interface.
* @get_current_image: return a #GdkPaintable that does not change over
* time. This means the GDK_PAINTABLE_STATIC_SIZE and
* %GDK_PAINTABLE_STATIC_CONTENTS flag are set.
* @get_flags: Get the flags for this instance. See #GdkPaintableFlags
* for details.
* guaranteed to be larger than 0.0. The resulting snapshot must modify
* only the area in the rectangle from (0,0) to (width, height).
* This is the only function that must be implemented for this interface.
* @get_current_image: return a `GdkPaintable` that does not change over
* time. This means the `GDK_PAINTABLE_STATIC_SIZE` and
* `GDK_PAINTABLE_STATIC_CONTENTS` flag are set.
* @get_flags: Get the flags for this instance. See [enum@Gdk.PaintableFlags]
* for details.
* @get_intrinsic_width: The preferred width for this object to be
* snapshot at or 0 if none. This is purely a hint. The object must still
* be able to render at any size.
* snapshot at or 0 if none. This is purely a hint. The object must still
* be able to render at any size.
* @get_intrinsic_height: The preferred height for this object to be
* snapshot at or 0 if none. This is purely a hint. The object must still
* be able to render at any size.
* snapshot at or 0 if none. This is purely a hint. The object must still
* be able to render at any size.
* @get_intrinsic_aspect_ratio: The preferred aspect ratio for this object
* or 0 if none. If both #GdkPaintableInterface.get_intrinsic_width() and
* #GdkPaintableInterface.get_intrinsic_height() return non-zero values,
* this function should return the aspect ratio computed from those.
* or 0 if none. If both [vfunc@Gdk.PaintableInterface.get_intrinsic_width]
* and [vfunc@Gdk.PaintableInterface.get_intrinsic_height] return non-zero
* values, this function should return the aspect ratio computed from those.
*
* The list of functions that can be implemented for the `GdkPaintable`
* interface.
*
* Note that apart from the #GdkPaintableInterface.snapshot() function, no
* virtual function of this interface is mandatory to implement, though it
* is a good idea to implement #GdkPaintableInterface.get_current_image()
* Note that apart from the [vfunc@Gdk.PaintableInterface.snapshot] function,
* no virtual function of this interface is mandatory to implement, though it
* is a good idea to implement [vfunc@Gdk.PaintableInterface.get_current_image]
* for non-static paintables and #GdkPaintableInterface.get_flags() if the
* image is not dynamic as the default implementation returns no flags and
* that will make the implementation likely quite slow.
......
......@@ -93,9 +93,8 @@ layout_iter_get_line_clip_region (PangoLayoutIter *iter,
* @line: a `PangoLayoutLine`
* @x_origin: X pixel where you intend to draw the layout line with this clip
* @y_origin: baseline pixel where you intend to draw the layout line with this clip
* @index_ranges: (array): array of byte indexes into the layout,
* where even members of array are start indexes and odd elements
* are end indexes
* @index_ranges: (array): array of byte indexes into the layout, where even
* members of array are start indexes and odd elements are end indexes
* @n_ranges: number of ranges in @index_ranges, i.e. half the size of @index_ranges
*
* Obtains a clip region which contains the areas where the given
......
......@@ -155,14 +155,14 @@ convert_no_alpha (guchar *dest_data,
* The pixbuf will contain an alpha channel if the @surface contains one.
*
* Returns: (nullable) (transfer full): A newly-created pixbuf with a
* reference count of 1, or %NULL on error
* reference count of 1
*/
GdkPixbuf *
gdk_pixbuf_get_from_surface (cairo_surface_t *surface,
int src_x,
int src_y,
int width,
int height)
gdk_pixbuf_get_from_surface (cairo_surface_t *surface,
int src_x,
int src_y,
int width,
int height)
{
cairo_content_t content;
GdkPixbuf *dest;
......
......@@ -122,8 +122,7 @@ gdk_rgba_is_opaque (const GdkRGBA *rgba)
*
* - For non-percentage values, we accept floats in the range 0-255
* not just [0-9]+ integers
* - For percentage values we accept any float, not just
* [ 0-9]+ | [0-9]* “.” [0-9]+
* - For percentage values we accept any float, not just [ 0-9]+ | [0-9]* “.” [0-9]+
* - We accept mixed percentages and non-percentages in a single
* rgb() or rgba() specification.
*/
......
......@@ -453,7 +453,7 @@ gdk_texture_download_area (GdkTexture *texture,
* gdk_texture_download:
* @texture: a `GdkTexture`
* @data: (array): pointer to enough memory to be filled with the
* downloaded data of @texture
* downloaded data of @texture
* @stride: rowstride in bytes
*
* Downloads the @texture into local memory.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment