Commit fff2b3c7 authored by Matthias Clasen's avatar Matthias Clasen
Browse files

gdk: Clean up docs syntax

Replace leftover gtk-doc syntax (#Type) with backquotes.
parent 2d0957b7
......@@ -50,7 +50,7 @@
/**
* GDK_WINDOWING_X11:
*
* The #GDK_WINDOWING_X11 macro is defined if the X11 backend
* The `GDK_WINDOWING_X11` macro is defined if the X11 backend
* is supported.
*
* Use this macro to guard code that is specific to the X11 backend.
......@@ -59,7 +59,7 @@
/**
* GDK_WINDOWING_WIN32:
*
* The #GDK_WINDOWING_WIN32 macro is defined if the Win32 backend
* The `GDK_WINDOWING_WIN32` macro is defined if the Win32 backend
* is supported.
*
* Use this macro to guard code that is specific to the Win32 backend.
......@@ -68,7 +68,7 @@
/**
* GDK_WINDOWING_MACOS:
*
* The #GDK_WINDOWING_MACOS macro is defined if the MacOS backend
* The `GDK_WINDOWING_MACOS` macro is defined if the MacOS backend
* is supported.
*
* Use this macro to guard code that is specific to the MacOS backend.
......@@ -77,7 +77,7 @@
/**
* GDK_WINDOWING_WAYLAND:
*
* The #GDK_WINDOWING_WAYLAND macro is defined if the Wayland backend
* The `GDK_WINDOWING_WAYLAND` macro is defined if the Wayland backend
* is supported.
*
* Use this macro to guard code that is specific to the Wayland backend.
......
......@@ -237,7 +237,7 @@ gdk_app_launch_context_set_timestamp (GdkAppLaunchContext *context,
/**
* gdk_app_launch_context_set_icon:
* @context: a `GdkAppLaunchContext`
* @icon: (nullable): a #GIcon
* @icon: (nullable): a `GIcon`
*
* Sets the icon for applications that are launched with this
* context.
......
......@@ -26,9 +26,9 @@
/**
* gdk_cairo_set_source_rgba:
* @cr: a cairo context
* @rgba: a #GdkRGBA
* @rgba: a `GdkRGBA`
*
* Sets the specified #GdkRGBA as the source color of @cr.
* Sets the specified `GdkRGBA` as the source color of @cr.
*/
void
gdk_cairo_set_source_rgba (cairo_t *cr,
......@@ -47,7 +47,7 @@ gdk_cairo_set_source_rgba (cairo_t *cr,
/**
* gdk_cairo_rectangle:
* @cr: a cairo context
* @rectangle: a #GdkRectangle
* @rectangle: a `GdkRectangle`
*
* Adds the given rectangle to the current path of @cr.
*/
......@@ -66,7 +66,7 @@ gdk_cairo_rectangle (cairo_t *cr,
/**
* gdk_cairo_region:
* @cr: a cairo context
* @region: a #cairo_region_t
* @region: a `cairo_region_t`
*
* Adds the given region to the current path of @cr.
*/
......@@ -185,7 +185,7 @@ gdk_cairo_surface_paint_pixbuf (cairo_surface_t *surface,
/**
* gdk_cairo_set_source_pixbuf:
* @cr: a cairo context
* @pixbuf: a #GdkPixbuf
* @pixbuf: a `GdkPixbuf`
* @pixbuf_x: X coordinate of location to place upper left corner of @pixbuf
* @pixbuf_y: Y coordinate of location to place upper left corner of @pixbuf
*
......@@ -232,7 +232,7 @@ gdk_cairo_set_source_pixbuf (cairo_t *cr,
* You must explicitly check the return value of you want to handle
* that case.
*
* Returns: %TRUE if the extents fit in a #GdkRectangle, %FALSE if not
* Returns: %TRUE if the extents fit in a `GdkRectangle`, %FALSE if not
*/
gboolean
_gdk_cairo_surface_extents (cairo_surface_t *surface,
......
......@@ -59,7 +59,7 @@ gdk_cairo_context_init (GdkCairoContext *self)
/**
* gdk_cairo_context_cairo_create:
* @self: a #GdkCairoContext that is currently drawing
* @self: a `GdkCairoContext` that is currently drawing
*
* Retrieves a Cairo context to be used to draw on the `GdkSurface`
* of @context.
......
......@@ -833,7 +833,7 @@ gdk_clipboard_read_value_internal (GdkClipboard *clipboard,
* @clipboard: a `GdkClipboard`
* @type: a `GType` to read
* @io_priority: the I/O priority of the request
* @cancellable: (nullable): optional #GCancellable object, %NULL to ignore.
* @cancellable: (nullable): optional `GCancellable` object
* @callback: (scope async): callback to call when the request is satisfied
* @user_data: (closure): the data to pass to callback function
*
......
......@@ -36,7 +36,7 @@ typedef struct _GdkContentDeserializer GdkContentDeserializer;
/**
* GdkContentDeserializeFunc:
* @deserializer: a #GdkContentDeserializer
* @deserializer: a `GdkContentDeserializer`
*
* The type of a function that can be registered with gdk_content_register_deserializer().
*
......
......@@ -411,7 +411,7 @@ gdk_content_formats_match_mime_type (const GdkContentFormats *first,
*
* Checks if a given `GType` is part of the given @formats.
*
* Returns: %TRUE if the #GType was found
* Returns: %TRUE if the `GType` was found
*/
gboolean
gdk_content_formats_contain_gtype (const GdkContentFormats *formats,
......@@ -458,7 +458,7 @@ gdk_content_formats_contain_mime_type (const GdkContentFormats *formats,
*
* Gets the `GType`s included in @formats.
*
* Note that @formats may not contain any #GTypes, in particular when
* Note that @formats may not contain any `GType`s, in particular when
* they are empty. In that case %NULL will be returned.
*
* Returns: (transfer none) (nullable) (array length=n_gtypes zero-terminated=1):
......
......@@ -218,7 +218,7 @@ gdk_content_provider_init (GdkContentProvider *provider)
/**
* gdk_content_provider_ref_formats: (attributes org.gtk.Method.get_property=formats)
* @provider: a #GdkContentProvider
* @provider: a `GdkContentProvider`
*
* Gets the formats that the provider can provide its current contents in.
*
......@@ -234,7 +234,7 @@ gdk_content_provider_ref_formats (GdkContentProvider *provider)
/**
* gdk_content_provider_ref_storable_formats: (attributes org.gtk.Method.get_property=storable-formats)
* @provider: a #GdkContentProvider
* @provider: a `GdkContentProvider`
*
* Gets the formats that the provider suggests other applications to store
* the data in.
......@@ -288,7 +288,7 @@ gdk_content_provider_content_changed (GdkContentProvider *provider)
*
* The given mime type does not need to be listed in the formats returned by
* [method@Gdk.ContentProvider.ref_formats]. However, if the given `GType` is
* not supported, #G_IO_ERROR_NOT_SUPPORTED will be reported.
* not supported, `G_IO_ERROR_NOT_SUPPORTED` will be reported.
*
* The given @stream will not be closed.
*/
......@@ -351,7 +351,7 @@ gdk_content_provider_write_mime_type_finish (GdkContentProvider *provider,
* provided in. This given `GType` does not need to be listed in the formats
* returned by [method@Gdk.ContentProvider.ref_formats]. However, if the
* given `GType` is not supported, this operation can fail and
* #G_IO_ERROR_NOT_SUPPORTED will be reported.
* `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.
......
......@@ -45,9 +45,9 @@ struct _GdkContentProvider
/**
* GdkContentProviderClass:
* @content_changed: Signal class closure for #GdkContentProvider::content-changed
* @content_changed: Signal class closure for `GdkContentProvider::content-changed`
*
* Class structure for #GdkContentProvider.
* Class structure for `GdkContentProvider`.
*/
struct _GdkContentProviderClass
{
......
......@@ -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 `GdkContentProvider`s to present the union of
* @n_providers: the number of providers
*
* Creates a content provider that represents all the given @providers.
......
......@@ -533,7 +533,7 @@ serialize_not_found (GdkContentSerializer *serializer)
* @mime_type: the mime type to serialize to
* @value: the content to serialize
* @io_priority: the I/O priority of the operation
* @cancellable: (nullable): optional #GCancellable object
* @cancellable: (nullable): optional `GCancellable` object
* @callback: (scope async): callback to call when the operation is done
* @user_data: (closure): data to pass to the callback function
*
......
......@@ -36,7 +36,7 @@ typedef struct _GdkContentSerializer GdkContentSerializer;
/**
* GdkContentSerializeFunc:
* @serializer: a #GdkContentSerializer
* @serializer: a `GdkContentSerializer`
*
* The type of a function that can be registered with gdk_content_register_serializer().
*
......
......@@ -410,7 +410,7 @@ gdk_cursor_get_name (GdkCursor *cursor)
/**
* gdk_cursor_get_texture:
* @cursor: a #GdkCursor.
* @cursor: a `GdkCursor`
*
* Returns the texture for the cursor.
*
......
......@@ -107,7 +107,7 @@ gdk_device_class_init (GdkDeviceClass *klass)
/**
* GdkDevice:display: (attributes org.gtk.Property.get=gdk_device_get_display)
*
* The #GdkDisplay the #GdkDevice pertains to.
* The `GdkDisplay` the `GdkDevice` pertains to.
*/
device_props[PROP_DISPLAY] =
g_param_spec_object ("display",
......@@ -1190,7 +1190,7 @@ gdk_device_set_seat (GdkDevice *device,
/**
* gdk_device_get_seat: (attributes org.gtk.Method.get_property=seat)
* @device: A #GdkDevice
* @device: A `GdkDevice`
*
* Returns the `GdkSeat` the device belongs to.
*
......
......@@ -64,11 +64,11 @@ typedef enum
/**
* GdkTimeCoord:
* @time: The timestamp for this event.
* @time: The timestamp for this event
* @flags: Flags indicating what axes are present
* @axes: (array fixed-size=12): axis values
*
* A #GdkTimeCoord stores a single event in a motion history.
* A `GdkTimeCoord` stores a single event in a motion history.
*/
struct _GdkTimeCoord
{
......
......@@ -36,7 +36,7 @@
* (current) for each given group, different groups may have different
* current modes. The number of available modes in a group can be found
* out through [method@Gdk.DevicePad.get_group_n_modes], and the current mode
* for a given group will be notified through events of type #GDK_PAD_GROUP_MODE.
* for a given group will be notified through events of type `GDK_PAD_GROUP_MODE`.
*/
#include "config.h"
......
......@@ -1141,13 +1141,13 @@ gdk_display_create_surface (GdkDisplay *display,
x, y, width, height);
}
/**
/*< private >
* gdk_display_get_keymap:
* @display: the `GdkDisplay`
*
* Returns the #GdkKeymap attached to @display.
* Returns the `GdkKeymap` attached to @display.
*
* Returns: (transfer none): the #GdkKeymap attached to @display.
* Returns: (transfer none): the `GdkKeymap` attached to @display.
*/
GdkKeymap *
gdk_display_get_keymap (GdkDisplay *display)
......@@ -1159,8 +1159,8 @@ gdk_display_get_keymap (GdkDisplay *display)
/*< private >
* gdk_display_make_gl_context_current:
* @display: a #GdkDisplay
* @context: (optional): a #GdkGLContext
* @display: a `GdkDisplay`
* @context: (optional): a `GdkGLContext`
*
* Makes the given @context the current GL context, or unsets
* the current GL context if @context is %NULL.
......@@ -1365,7 +1365,7 @@ gdk_display_list_seats (GdkDisplay *display)
* You can listen to the GListModel::items-changed signal on
* this list to monitor changes to the monitor of this display.
*
* Returns: (transfer none): a #GListModel of `GdkMonitor`
* Returns: (transfer none): a `GListModel` of `GdkMonitor`
*/
GListModel *
gdk_display_get_monitors (GdkDisplay *self)
......
......@@ -76,7 +76,7 @@
*
* When writing backend-specific code that is supposed to work with
* multiple GDK backends, you have to consider both compile time and
* runtime. At compile time, use the #GDK_WINDOWING_X11, #GDK_WINDOWING_WIN32
* runtime. At compile time, use the `GDK_WINDOWING_X11`, `GDK_WINDOWING_WIN32`
* macros, etc. to find out which backends are present in the GDK library
* you are building your application against. At runtime, use type-check
* macros like GDK_IS_X11_DISPLAY() to find out which backend is in use:
......
......@@ -26,7 +26,7 @@
/**
* GdkDragSurface:
*
* A #GdkDragSurface is an interface for surfaces used during DND.
* A `GdkDragSurface` is an interface for surfaces used during DND.
*/
/**
......
......@@ -237,7 +237,7 @@ gdk_draw_context_get_display (GdkDrawContext *context)
*
* Retrieves the surface that @context is bound to.
*
* Returns: (nullable) (transfer none): the #GdkSurface
* Returns: (nullable) (transfer none): a `GdkSurface`
*/
GdkSurface *
gdk_draw_context_get_surface (GdkDrawContext *context)
......@@ -382,7 +382,7 @@ gdk_draw_context_end_frame (GdkDrawContext *context)
/**
* gdk_draw_context_get_frame_region:
* @context: a #GdkDrawContext
* @context: a `GdkDrawContext`
*
* Retrieves the region that is currently being repainted.
*
......
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