docs: Clean up dangling links in gdk docs

Clean up references to no-longer-existing APIs.
This commit is contained in:
Matthias Clasen 2020-08-05 15:42:27 -04:00
parent d7c4f93c76
commit 1d7b273669
21 changed files with 57 additions and 71 deletions

View File

@ -33,6 +33,7 @@
<xi:include href="xml/gdksurface.xml" /> <xi:include href="xml/gdksurface.xml" />
<xi:include href="xml/gdktoplevel.xml" /> <xi:include href="xml/gdktoplevel.xml" />
<xi:include href="xml/gdktoplevellayout.xml" /> <xi:include href="xml/gdktoplevellayout.xml" />
<xi:include href="xml/gdktoplevelsize.xml" />
<xi:include href="xml/gdkpopup.xml" /> <xi:include href="xml/gdkpopup.xml" />
<xi:include href="xml/gdkpopuplayout.xml" /> <xi:include href="xml/gdkpopuplayout.xml" />
<xi:include href="xml/gdkframeclock.xml" /> <xi:include href="xml/gdkframeclock.xml" />

View File

@ -345,7 +345,6 @@ GdkAxisUse
GdkAxisFlags GdkAxisFlags
GdkDeviceTool GdkDeviceTool
GdkDeviceToolType GdkDeviceToolType
GdkDeviceType
<SUBSECTION> <SUBSECTION>
gdk_device_get_name gdk_device_get_name
@ -684,6 +683,8 @@ gdk_toplevel_get_type
<TITLE>Textures</TITLE> <TITLE>Textures</TITLE>
<FILE>textures</FILE> <FILE>textures</FILE>
GdkTexture GdkTexture
GdkMemoryTexture
GdkGLTexture
gdk_texture_new_for_pixbuf gdk_texture_new_for_pixbuf
gdk_texture_new_from_resource gdk_texture_new_from_resource
gdk_texture_new_from_file gdk_texture_new_from_file
@ -847,6 +848,8 @@ gdk_x11_surface_move_to_desktop
gdk_x11_surface_get_desktop gdk_x11_surface_get_desktop
gdk_x11_surface_set_utf8_property gdk_x11_surface_set_utf8_property
gdk_x11_surface_set_frame_sync_enabled gdk_x11_surface_set_frame_sync_enabled
gdk_x11_surface_set_group
gdk_x11_surface_get_group
gdk_x11_keymap_get_group_for_state gdk_x11_keymap_get_group_for_state
gdk_x11_keymap_key_is_modifier gdk_x11_keymap_key_is_modifier
gdk_x11_visual_get_xvisual gdk_x11_visual_get_xvisual
@ -1290,4 +1293,3 @@ GDK_CONTENT_DESERIALIZER
GDK_IS_CONTENT_DESERIALIZER GDK_IS_CONTENT_DESERIALIZER
gdk_content_deserializer_get_type gdk_content_deserializer_get_type
</SECTION> </SECTION>

View File

@ -319,9 +319,8 @@ gdk_pre_parse (void)
* *
* Opens the default display specified by command line arguments or * Opens the default display specified by command line arguments or
* environment variables, sets it as the default display, and returns * environment variables, sets it as the default display, and returns
* it. gdk_parse_args() must have been called first. If the default * it. If the default display has previously been set, simply returns
* display has previously been set, simply returns that. An internal * that. An internal function that should not be used by applications.
* function that should not be used by applications.
* *
* Returns: (nullable) (transfer none): the default display, if it * Returns: (nullable) (transfer none): the default display, if it
* could be opened, otherwise %NULL. * could be opened, otherwise %NULL.

View File

@ -20,7 +20,7 @@
* @Title: Content Formats * @Title: Content Formats
* @Short_description: Advertising and negotiating of content * @Short_description: Advertising and negotiating of content
* exchange formats * exchange formats
* @See_also: #GdkDragContext, #GdkClipboard, #GdkContentProvider * @See_also: #GdkDrag, #GdkDrop, #GdkClipboard, #GdkContentProvider
* *
* This section describes the #GdkContentFormats structure that is used to * This section describes the #GdkContentFormats structure that is used to
* advertise and negotiate the format of content passed between different * advertise and negotiate the format of content passed between different

View File

@ -32,14 +32,12 @@
* and gdk_device_pad_get_feature_group() can be combined to find out the * and gdk_device_pad_get_feature_group() can be combined to find out the
* number of buttons/rings/strips the device has, and how are they grouped. * number of buttons/rings/strips the device has, and how are they grouped.
* *
* Each of those groups have different modes, which may be used to map * Each of those groups have different modes, which may be used to map each
* each individual pad feature to multiple actions. Only one mode is * individual pad feature to multiple actions. Only one mode is effective
* effective (current) for each given group, different groups may have * (current) for each given group, different groups may have different
* different current modes. The number of available modes in a group can * current modes. The number of available modes in a group can be found
* be found out through gdk_device_pad_get_group_n_modes(), and the current * out through gdk_device_pad_get_group_n_modes(), and the current mode for
* mode for a given group will be notified through the #GdkEventPadGroupMode * a given group will be notified through events of type #GDK_PAD_GROUP_MODE.
* event.
*
*/ */
/** /**

View File

@ -54,7 +54,7 @@
* gdk_display_get_default_seat() and gdk_display_list_seats(). * gdk_display_get_default_seat() and gdk_display_list_seats().
* *
* Output devices are represented by #GdkMonitor objects, which can be accessed * Output devices are represented by #GdkMonitor objects, which can be accessed
* with gdk_display_get_monitor() and similar APIs. * with gdk_display_get_monitor_at_surface() and similar APIs.
*/ */
/** /**
@ -957,9 +957,9 @@ gdk_display_beep (GdkDisplay *display)
* Flushes any requests queued for the windowing system and waits until all * Flushes any requests queued for the windowing system and waits until all
* requests have been handled. This is often used for making sure that the * requests have been handled. This is often used for making sure that the
* display is synchronized with the current state of the program. Calling * display is synchronized with the current state of the program. Calling
* gdk_display_sync() before gdk_error_trap_pop() makes sure that any errors * gdk_display_sync() before gdk_x11_display_error_trap_pop() makes sure
* generated from earlier requests are handled before the error trap is * that any errors generated from earlier requests are handled before the
* removed. * error trap is removed.
* *
* This is most useful for X11. On windowing systems where requests are * This is most useful for X11. On windowing systems where requests are
* handled synchronously, this function will do nothing. * handled synchronously, this function will do nothing.
@ -1320,9 +1320,6 @@ gdk_display_set_composited (GdkDisplay *display,
* provide appropriate display. Use gdk_display_is_composited() * provide appropriate display. Use gdk_display_is_composited()
* to check if that is the case. * to check if that is the case.
* *
* For setting an overall opacity for a top-level surface, see
* gdk_surface_set_opacity().
*
* On modern displays, this value is always %TRUE. * On modern displays, this value is always %TRUE.
* *
* Returns: %TRUE if surfaces are created with an alpha channel or * Returns: %TRUE if surfaces are created with an alpha channel or

View File

@ -296,9 +296,7 @@ static GdkBackend gdk_backends[] = {
* with multiple backends). Applications can use gdk_set_allowed_backends() * with multiple backends). Applications can use gdk_set_allowed_backends()
* to limit what backends can be used. * to limit what backends can be used.
* *
* Returns: (transfer none): The global #GdkDisplayManager singleton; * Returns: (transfer none): The global #GdkDisplayManager singleton
* gdk_parse_args(), gdk_init(), or gdk_init_check() must have
* been called first.
**/ **/
GdkDisplayManager* GdkDisplayManager*
gdk_display_manager_get (void) gdk_display_manager_get (void)

View File

@ -105,7 +105,7 @@ G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GdkDrag, gdk_drag, G_TYPE_OBJECT)
* Possible drop sites get informed about the status of the ongoing drag operation * Possible drop sites get informed about the status of the ongoing drag operation
* with events of type %GDK_DRAG_ENTER, %GDK_DRAG_LEAVE, %GDK_DRAG_MOTION and * with events of type %GDK_DRAG_ENTER, %GDK_DRAG_LEAVE, %GDK_DRAG_MOTION and
* %GDK_DROP_START. The #GdkDrop object can be obtained from these #GdkEvents * %GDK_DROP_START. The #GdkDrop object can be obtained from these #GdkEvents
* using gdk_event_get_drop(). * using gdk_dnd_event_get_drop().
* *
* The actual data transfer is initiated from the target side via an async * The actual data transfer is initiated from the target side via an async
* read, using one of the GdkDrop functions for this purpose: gdk_drop_read_async() * read, using one of the GdkDrop functions for this purpose: gdk_drop_read_async()

View File

@ -482,7 +482,7 @@ gdk_drop_get_surface (GdkDrop *self)
* returns %FALSE for the result - gdk_drop_finish() must choose * returns %FALSE for the result - gdk_drop_finish() must choose
* the action to use when accepting the drop. This will only * the action to use when accepting the drop. This will only
* happen if you passed %GDK_ACTION_ASK as one of the possible * happen if you passed %GDK_ACTION_ASK as one of the possible
* actions in gdk_drag_status(). %GDK_ACTION_ASK itself will not * actions in gdk_drop_status(). %GDK_ACTION_ASK itself will not
* be included in the actions returned by this function. * be included in the actions returned by this function.
* *
* This value may change over the lifetime of the #GdkDrop both * This value may change over the lifetime of the #GdkDrop both

View File

@ -945,9 +945,9 @@ gdk_event_get_axis (GdkEvent *event,
* gdk_event_triggers_context_menu: * gdk_event_triggers_context_menu:
* @event: a #GdkEvent, currently only button events are meaningful values * @event: a #GdkEvent, currently only button events are meaningful values
* *
* This function returns whether a #GdkEventButton should trigger a * This function returns whether a #GdkEvent should trigger a
* context menu, according to platform conventions. The right mouse * context menu, according to platform conventions. The right
* button always triggers context menus. * mouse button always triggers context menus.
* *
* This function should always be used instead of simply checking for * This function should always be used instead of simply checking for
* event->button == %GDK_BUTTON_SECONDARY. * event->button == %GDK_BUTTON_SECONDARY.

View File

@ -252,7 +252,7 @@ typedef enum
* @GDK_SCROLL_LEFT: the surface is scrolled to the left. * @GDK_SCROLL_LEFT: the surface is scrolled to the left.
* @GDK_SCROLL_RIGHT: the surface is scrolled to the right. * @GDK_SCROLL_RIGHT: the surface is scrolled to the right.
* @GDK_SCROLL_SMOOTH: the scrolling is determined by the delta values * @GDK_SCROLL_SMOOTH: the scrolling is determined by the delta values
* in scroll events. See gdk_event_get_scroll_deltas() * in scroll events. See gdk_scroll_event_get_deltas()
* *
* Specifies the direction for scroll events. * Specifies the direction for scroll events.
*/ */

View File

@ -208,8 +208,8 @@ gdk_frame_clock_class_init (GdkFrameClockClass *klass)
* This signal is emitted as the third step of toolkit and * This signal is emitted as the third step of toolkit and
* application processing of the frame. The frame is * application processing of the frame. The frame is
* repainted. GDK normally handles this internally and * repainted. GDK normally handles this internally and
* produces expose events, which are turned into GTK * emits #GdkSurface::render which are turned into
* #GtkWidget::draw signals. * #GtkWidget::snapshot signals by GTK.
*/ */
signals[PAINT] = signals[PAINT] =
g_signal_new (g_intern_static_string ("paint"), g_signal_new (g_intern_static_string ("paint"),

View File

@ -56,11 +56,11 @@ void gtk_snapshot_pop (GdkSnapshot
* A #GdkPaintable may change its contents, meaning that it will now produce a * A #GdkPaintable may change its contents, meaning that it will now produce a
* different output with the same snpashot. Once that happens, it will call * different output with the same snpashot. Once that happens, it will call
* gdk_paintable_invalidate_contents() which will emit the * gdk_paintable_invalidate_contents() which will emit the
* #GdkPaintable::invalidate-contents signal. * #GdkPaintable::invalidate-contents signal. If a paintable is known to never
* If a paintable is known to never change its contents, it will set the * change its contents, it will set the %GDK_PAINTABLE_STATIC_CONTENTS flag.
* %GDK_PAINTABLE_STATIC_CONTENTS flag. If a consumer cannot deal with changing * If a consumer cannot deal with changing contents, it may call
* contents, it may call gdk_paintable_get_static_image() which will return a * gdk_paintable_get_current_image() which will return a static paintable and
* static paintable and use that. * use that.
* *
* A paintable can report an intrinsic (or preferred) size or aspect ratio it * A paintable can report an intrinsic (or preferred) size or aspect ratio it
* wishes to be rendered at, though it doesn't have to. Consumers of the interface * wishes to be rendered at, though it doesn't have to. Consumers of the interface

View File

@ -55,13 +55,12 @@ G_DEFINE_BOXED_TYPE (GdkPopupLayout, gdk_popup_layout,
* @rect_anchor: the point on @anchor_rect to align with @surface's anchor point * @rect_anchor: the point on @anchor_rect to align with @surface's anchor point
* @surface_anchor: the point on @surface to align with @rect's anchor point * @surface_anchor: the point on @surface to align with @rect's anchor point
* *
* Create a popup layout description. Used together with * Create a popup layout description. Used together with gdk_popup_present()
* gdk_surface_present_popup() to describe how a popup surface should be placed * to describe how a popup surface should be placed and behave on-screen.
* and behave on-screen.
* *
* @anchor_rect is relative to the top-left corner of the surface's parent. * @anchor_rect is relative to the top-left corner of the surface's parent.
* @rect_anchor and @surface_anchor determine anchor points on @anchor_rect and * @rect_anchor and @surface_anchor determine anchor points on @anchor_rect
* surface to pin together. * and surface to pin together.
* *
* The position of @anchor_rect's anchor point can optionally be offset using * The position of @anchor_rect's anchor point can optionally be offset using
* gdk_popup_layout_set_offset(), which is equivalent to offsetting the * gdk_popup_layout_set_offset(), which is equivalent to offsetting the

View File

@ -839,8 +839,8 @@ gdk_surface_new_temp (GdkDisplay *display,
* *
* Create a new popup surface. * Create a new popup surface.
* *
* The surface will be attached to @parent and can be positioned relative to it * The surface will be attached to @parent and can be positioned
* using gdk_surface_show_popup() or later using gdk_surface_layout_popup(). * relative to it using gdk_popup_present().
* *
* Returns: (transfer full): a new #GdkSurface * Returns: (transfer full): a new #GdkSurface
*/ */
@ -1021,8 +1021,8 @@ gdk_surface_is_destroyed (GdkSurface *surface)
* gdk_surface_get_mapped: * gdk_surface_get_mapped:
* @surface: a #GdkSurface * @surface: a #GdkSurface
* *
* Checks whether the surface has been mapped (with gdk_surface_show() or * Checks whether the surface has been mapped (with gdk_toplevel_present()
* gdk_surface_show_unraised()). * or gdk_popup_present()).
* *
* Returns: %TRUE if the surface is mapped * Returns: %TRUE if the surface is mapped
**/ **/
@ -2024,7 +2024,7 @@ gdk_surface_get_root_coords (GdkSurface *surface,
* and the input region controls where the surface is * and the input region controls where the surface is
* clickable. * clickable.
* *
* Use gdk_display_support_input_shapes() to find out if * Use gdk_display_supports_input_shapes() to find out if
* a particular backend supports input regions. * a particular backend supports input regions.
*/ */
void void

View File

@ -881,7 +881,7 @@ gdk_wayland_display_get_startup_notification_id (GdkDisplay *display)
* *
* The startup ID is also what is used to signal that the startup is * The startup ID is also what is used to signal that the startup is
* complete (for example, when opening a window or when calling * complete (for example, when opening a window or when calling
* gdk_notify_startup_complete()). * gdk_display_notify_startup_complete()).
**/ **/
void void
gdk_wayland_display_set_startup_notification_id (GdkDisplay *display, gdk_wayland_display_set_startup_notification_id (GdkDisplay *display,

View File

@ -336,12 +336,10 @@ _gdk_win32_display_init_monitors (GdkWin32Display *win32_display)
* should be taken. * should be taken.
* *
* If the windowing system supports it, existing cursors created * If the windowing system supports it, existing cursors created
* with gdk_cursor_new(), gdk_cursor_new_for_display() and * with gdk_cursor_new_from_name() are updated to reflect the theme
* gdk_cursor_new_from_name() are updated to reflect the theme * change. Custom cursors constructed with gdk_cursor_new_from_texture()
* change. Custom cursors constructed with * will have to be handled by the application (GTK applications can
* gdk_cursor_new_from_texture() will have to be handled * learn about cursor theme changes by listening for change notification
* by the application (GTK+ applications can learn about
* cursor theme changes by listening for change notification
* for the corresponding #GtkSetting). * for the corresponding #GtkSetting).
*/ */
void void

View File

@ -269,12 +269,10 @@ gdk_x11_cursor_create_for_name (GdkDisplay *display,
* should be taken. * should be taken.
* *
* If the windowing system supports it, existing cursors created * If the windowing system supports it, existing cursors created
* with gdk_cursor_new(), gdk_cursor_new_for_display() and * with gdk_cursor_new_from_name() are updated to reflect the theme
* gdk_cursor_new_from_name() are updated to reflect the theme * change. Custom cursors constructed with gdk_cursor_new_from_texture()
* change. Custom cursors constructed with * will have to be handled by the application (GTK applications can learn
* gdk_cursor_new_from_texture() will have to be handled * about cursor theme changes by listening for change notification
* by the application (GTK+ applications can learn about
* cursor theme changes by listening for change notification
* for the corresponding #GtkSetting). * for the corresponding #GtkSetting).
*/ */
void void

View File

@ -1836,7 +1836,7 @@ gdk_x11_display_has_pending (GdkDisplay *display)
* *
* Returns the default group leader surface for all toplevel surfaces * Returns the default group leader surface for all toplevel surfaces
* on @display. This surface is implicitly created by GDK. * on @display. This surface is implicitly created by GDK.
* See gdk_surface_set_group(). * See gdk_x11_surface_set_group().
* *
* Returns: (transfer none): The default group leader surface * Returns: (transfer none): The default group leader surface
* for @display * for @display
@ -2359,7 +2359,7 @@ gdk_x11_display_get_startup_notification_id (GdkDisplay *display)
* *
* The startup ID is also what is used to signal that the startup is * The startup ID is also what is used to signal that the startup is
* complete (for example, when opening a window or when calling * complete (for example, when opening a window or when calling
* gdk_notify_startup_complete()). * gdk_display_notify_startup_complete()).
**/ **/
void void
gdk_x11_display_set_startup_notification_id (GdkDisplay *display, gdk_x11_display_set_startup_notification_id (GdkDisplay *display,
@ -2542,8 +2542,6 @@ delete_outdated_error_traps (GdkX11Display *display_x11)
* the application. Use gdk_x11_display_error_trap_pop() or * the application. Use gdk_x11_display_error_trap_pop() or
* gdk_x11_display_error_trap_pop_ignored()to lift a trap pushed * gdk_x11_display_error_trap_pop_ignored()to lift a trap pushed
* with this function. * with this function.
*
* See also gdk_error_trap_push() to push a trap on all displays.
*/ */
void void
gdk_x11_display_error_trap_push (GdkDisplay *display) gdk_x11_display_error_trap_push (GdkDisplay *display)
@ -2695,9 +2693,6 @@ gdk_x11_display_set_surface_scale (GdkDisplay *display,
* If you dont need to use the return value, * If you dont need to use the return value,
* gdk_x11_display_error_trap_pop_ignored() would be more efficient. * gdk_x11_display_error_trap_pop_ignored() would be more efficient.
* *
* See gdk_error_trap_pop() for the all-displays-at-once
* equivalent.
*
* Returns: X error code or 0 on success * Returns: X error code or 0 on success
*/ */
int int
@ -2716,9 +2711,6 @@ gdk_x11_display_error_trap_pop (GdkDisplay *display)
* Does not block to see if an error occurred; merely records the * Does not block to see if an error occurred; merely records the
* range of requests to ignore errors for, and ignores those errors * range of requests to ignore errors for, and ignores those errors
* if they arrive asynchronously. * if they arrive asynchronously.
*
* See gdk_error_trap_pop_ignored() for the all-displays-at-once
* equivalent.
*/ */
void void
gdk_x11_display_error_trap_pop_ignored (GdkDisplay *display) gdk_x11_display_error_trap_pop_ignored (GdkDisplay *display)

View File

@ -117,6 +117,10 @@ gdk_x11_monitor_class_init (GdkX11MonitorClass *class)
/** /**
* gdk_x11_monitor_get_output: * gdk_x11_monitor_get_output:
* @monitor: (type GdkX11Monitor): a #GdkMonitor * @monitor: (type GdkX11Monitor): a #GdkMonitor
*
* Returns the XID of the Output corresponding to @monitor.
*
* Returns: the XID of @monitor
*/ */
XID XID
gdk_x11_monitor_get_output (GdkMonitor *monitor) gdk_x11_monitor_get_output (GdkMonitor *monitor)

View File

@ -43,7 +43,7 @@
* @length: The number of items to transform * @length: The number of items to transform
* @list: location to store an array of strings in * @list: location to store an array of strings in
* the encoding of the current locale. This array should be * the encoding of the current locale. This array should be
* freed using gdk_free_text_list(). * freed using gdk_x11_free_text_list().
* *
* Convert a text string from the encoding as it is stored * Convert a text string from the encoding as it is stored
* in a property into an array of strings in the encoding of * in a property into an array of strings in the encoding of