diff --git a/gdk/gdk.c b/gdk/gdk.c index 075f7c07d3..a708eb8c9b 100644 --- a/gdk/gdk.c +++ b/gdk/gdk.c @@ -434,7 +434,7 @@ gdk_init_check (int *argc, * * Initializes the GDK library and connects to the windowing system. * If initialization fails, a warning message is output and the application - * terminates with a call to exit(1). + * terminates with a call to `exit(1)`. * * Any arguments used by GDK are removed from the array and @argc and @argv * are updated accordingly. @@ -1115,7 +1115,7 @@ gdk_get_program_class (void) * @program_class: a string. * * Sets the program class. The X11 backend uses the program class to set - * the class name part of the WM_CLASS property on + * the class name part of the `WM_CLASS` property on * toplevel windows; see the ICCCM. */ void diff --git a/gdk/gdkcolor.c b/gdk/gdkcolor.c index 4fe82d1206..a71af0da09 100644 --- a/gdk/gdkcolor.c +++ b/gdk/gdkcolor.c @@ -164,8 +164,8 @@ gdk_color_parse (const gchar *spec, * @color: a #GdkColor * * Returns a textual specification of @color in the hexadecimal form - * #rrrrggggbbbb, where r, - * g and b are hex digits + * `#rrrrggggbbbb`, where `r`, + * `g` and `b` are hex digits * representing the red, green and blue components respectively. * * The returned string can be parsed by gdk_color_parse(). diff --git a/gdk/gdkcursor.c b/gdk/gdkcursor.c index f4e9417f24..9f8603fc68 100644 --- a/gdk/gdkcursor.c +++ b/gdk/gdkcursor.c @@ -296,9 +296,9 @@ gdk_cursor_new_from_name (GdkDisplay *display, * gdk_display_get_maximal_cursor_size() give information about * cursor sizes. * - * If @x or @y are -1, the pixbuf must have + * If @x or @y are `-1`, the pixbuf must have * options named "x_hot" and "y_hot", resp., containing - * integer values between 0 and the width resp. height of + * integer values between `0` and the width resp. height of * the pixbuf. (Since: 3.0) * * On the X backend, support for RGBA cursors requires a diff --git a/gdk/gdkdisplaymanager.c b/gdk/gdkdisplaymanager.c index 193164a68c..a3cd8538e0 100644 --- a/gdk/gdkdisplaymanager.c +++ b/gdk/gdkdisplaymanager.c @@ -328,8 +328,8 @@ gdk_display_manager_get_default_display (GdkDisplayManager *manager) * gdk_display_get_default: * * Gets the default #GdkDisplay. This is a convenience - * function for - * gdk_display_manager_get_default_display (gdk_display_manager_get ()). + * function for: + * `gdk_display_manager_get_default_display (gdk_display_manager_get ())`. * * Returns: (transfer none): a #GdkDisplay, or %NULL if there is no default * display. diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c index 70bd6d8429..adba6d11bc 100644 --- a/gdk/gdkevents.c +++ b/gdk/gdkevents.c @@ -1914,12 +1914,12 @@ gdk_event_set_screen (GdkEvent *event, * @event: a #GdkEvent * * Returns the screen for the event. The screen is - * typically the screen for event->any.window, but + * typically the screen for `event->any.window`, but * for events such as mouse events, it is the screen * where the pointer was when the event occurs - * that is, the screen which has the root window - * to which event->motion.x_root and - * event->motion.y_root are relative. + * to which `event->motion.x_root` and + * `event->motion.y_root` are relative. * * Return value: (transfer none): the screen for the event * diff --git a/gdk/gdkevents.h b/gdk/gdkevents.h index 5ab75c09bc..e28b0fdf39 100644 --- a/gdk/gdkevents.h +++ b/gdk/gdkevents.h @@ -176,7 +176,7 @@ typedef void GdkXEvent; /* Can be cast to window system specific * GdkFilterReturn: * @GDK_FILTER_CONTINUE: event not handled, continue processing. * @GDK_FILTER_TRANSLATE: native event translated into a GDK event and stored - * in the event structure that was passed in. + * in the `event` structure that was passed in. * @GDK_FILTER_REMOVE: event handled, terminate processing. * * Specifies the result of applying a #GdkFilterFunc to a native event. @@ -199,7 +199,7 @@ typedef enum { * converted to GDK events. * * When a filter is called, @event is unpopulated, except for - * event->window. The filter may translate the native + * `event->window`. The filter may translate the native * event to a GDK event and store the result in @event, or handle it without * translation. If the filter translates the event and processing should * continue, it should return %GDK_FILTER_TRANSLATE. @@ -285,7 +285,7 @@ typedef GdkFilterReturn (*GdkFilterFunc) (GdkXEvent *xevent, * * In some language bindings, the values %GDK_2BUTTON_PRESS and * %GDK_3BUTTON_PRESS would translate into something syntactically - * invalid (eg Gdk.EventType.2ButtonPress, where a + * invalid (eg `Gdk.EventType.2ButtonPress`, where a * symbol is not allowed to start with a number). In that case, the * aliases %GDK_DOUBLE_BUTTON_PRESS and %GDK_TRIPLE_BUTTON_PRESS can * be used instead. diff --git a/gdk/gdkkeys.c b/gdk/gdkkeys.c index da5664c6a8..880d75dd00 100644 --- a/gdk/gdkkeys.c +++ b/gdk/gdkkeys.c @@ -497,9 +497,9 @@ gdk_keymap_lookup_key (GdkKeymap *keymap, * * @consumed_modifiers gives modifiers that should be masked out * from @state when comparing this key press to a hot key. For - * instance, on a US keyboard, the plus + * instance, on a US keyboard, the `plus` * symbol is shifted, so when comparing a key press to a - * <Control>plus accelerator <Shift> should + * `<Control>plus` accelerator <Shift> should * be masked out. * * |[ @@ -525,16 +525,16 @@ gdk_keymap_lookup_key (GdkKeymap *keymap, * ]| * * However, this did not work if multi-modifier combinations were - * used in the keymap, since, for instance, <Control> - * would be masked out even if only <Control><Alt> + * used in the keymap, since, for instance, `<Control>` + * would be masked out even if only `<Control><Alt>` * was used in the keymap. To support this usage as well as well as * possible, all single modifier combinations * that could affect the key for any combination of modifiers will * be returned in @consumed_modifiers; multi-modifier combinations * are returned only when actually found in @state. When you store * accelerators, you should always store them with consumed modifiers - * removed. Store <Control>plus, - * not <Control><Shift>plus, + * removed. Store `<Control>plus`, + * not `<Control><Shift>plus`, * * Return value: %TRUE if there was a keyval bound to the keycode/state/group **/ diff --git a/gdk/gdkrgba.c b/gdk/gdkrgba.c index 6a27ba1192..f60929f33f 100644 --- a/gdk/gdkrgba.c +++ b/gdk/gdkrgba.c @@ -330,8 +330,8 @@ gdk_rgba_equal (gconstpointer p1, * @rgba: a #GdkRGBA * * Returns a textual specification of @rgba in the form - * rgb (r, g, b) or - * rgba (r, g, b, a), + * `rgb (r, g, b)` or + * `rgba (r, g, b, a)`, * where 'r', 'g', 'b' and 'a' represent the red, green, * blue and alpha values respectively. r, g, and b are * represented as integers in the range 0 to 255, and a diff --git a/gdk/gdkselection.c b/gdk/gdkselection.c index 28f46f8d63..326cfdebfa 100644 --- a/gdk/gdkselection.c +++ b/gdk/gdkselection.c @@ -40,12 +40,12 @@ * a named clipboard, identified by a string interned as a #GdkAtom. By * claiming ownership of a selection, an application indicates that it will * be responsible for supplying its contents. The most common selections are - * PRIMARY and CLIPBOARD. + * `PRIMARY` and `CLIPBOARD`. * * The contents of a selection can be represented in a number of formats, * called “targets”. Each target is identified by an atom. * A list of all possible targets supported by the selection owner can be - * retrieved by requesting the special target TARGETS. When + * retrieved by requesting the special target `TARGETS`. When * a selection is retrieved, the data is accompanied by a type (an atom), and * a format (an integer, representing the number of bits per item). * See Properties and Atoms @@ -54,7 +54,7 @@ * The functions in this section only contain the lowlevel parts of the * selection protocol. A considerably more complicated implementation is needed * on top of this. GTK+ contains such an implementation in the functions in - * gtkselection.h and programmers should use those functions + * `gtkselection.h` and programmers should use those functions * instead of the ones presented here. If you plan to implement selection * handling directly on top of the functions here, you should refer to the * X Inter-client Communication Conventions Manual (ICCCM). diff --git a/gdk/gdkselection.h b/gdk/gdkselection.h index 10d3935e41..6520624bfe 100644 --- a/gdk/gdkselection.h +++ b/gdk/gdkselection.h @@ -40,112 +40,112 @@ G_BEGIN_DECLS /** * GDK_SELECTION_PRIMARY: * - * A #GdkAtom representing the PRIMARY selection. + * A #GdkAtom representing the `PRIMARY` selection. */ #define GDK_SELECTION_PRIMARY _GDK_MAKE_ATOM (1) /** * GDK_SELECTION_SECONDARY: * - * A #GdkAtom representing the SECONDARY selection. + * A #GdkAtom representing the `SECONDARY` selection. */ #define GDK_SELECTION_SECONDARY _GDK_MAKE_ATOM (2) /** * GDK_SELECTION_CLIPBOARD: * - * A #GdkAtom representing the CLIPBOARD selection. + * A #GdkAtom representing the `CLIPBOARD` selection. */ #define GDK_SELECTION_CLIPBOARD _GDK_MAKE_ATOM (69) /** * GDK_TARGET_BITMAP: * - * A #GdkAtom representing the BITMAP selection target. + * A #GdkAtom representing the `BITMAP` selection target. */ #define GDK_TARGET_BITMAP _GDK_MAKE_ATOM (5) /** * GDK_TARGET_COLORMAP: * - * A #GdkAtom representing the COLORMAP selection target. + * A #GdkAtom representing the `COLORMAP` selection target. */ #define GDK_TARGET_COLORMAP _GDK_MAKE_ATOM (7) /** * GDK_TARGET_DRAWABLE: * - * A #GdkAtom representing the DRAWABLE selection target. + * A #GdkAtom representing the `DRAWABLE` selection target. */ #define GDK_TARGET_DRAWABLE _GDK_MAKE_ATOM (17) /** * GDK_TARGET_PIXMAP: * - * A #GdkAtom representing the PIXMAP selection target. + * A #GdkAtom representing the `PIXMAP` selection target. */ #define GDK_TARGET_PIXMAP _GDK_MAKE_ATOM (20) /** * GDK_TARGET_STRING: * - * A #GdkAtom representing the STRING selection target. + * A #GdkAtom representing the `STRING` selection target. */ #define GDK_TARGET_STRING _GDK_MAKE_ATOM (31) /** * GDK_SELECTION_TYPE_ATOM: * - * A #GdkAtom representing the ATOM selection type. + * A #GdkAtom representing the `ATOM` selection type. */ #define GDK_SELECTION_TYPE_ATOM _GDK_MAKE_ATOM (4) /** * GDK_SELECTION_TYPE_BITMAP: * - * A #GdkAtom representing the BITMAP selection type. + * A #GdkAtom representing the `BITMAP` selection type. */ #define GDK_SELECTION_TYPE_BITMAP _GDK_MAKE_ATOM (5) /** * GDK_SELECTION_TYPE_COLORMAP: * - * A #GdkAtom representing the COLORMAP selection type. + * A #GdkAtom representing the `COLORMAP` selection type. */ #define GDK_SELECTION_TYPE_COLORMAP _GDK_MAKE_ATOM (7) /** * GDK_SELECTION_TYPE_DRAWABLE: * - * A #GdkAtom representing the DRAWABLE selection type. + * A #GdkAtom representing the `DRAWABLE` selection type. */ #define GDK_SELECTION_TYPE_DRAWABLE _GDK_MAKE_ATOM (17) /** * GDK_SELECTION_TYPE_INTEGER: * - * A #GdkAtom representing the INTEGER selection type. + * A #GdkAtom representing the `INTEGER` selection type. */ #define GDK_SELECTION_TYPE_INTEGER _GDK_MAKE_ATOM (19) /** * GDK_SELECTION_TYPE_PIXMAP: * - * A #GdkAtom representing the PIXMAP selection type. + * A #GdkAtom representing the `PIXMAP` selection type. */ #define GDK_SELECTION_TYPE_PIXMAP _GDK_MAKE_ATOM (20) /** * GDK_SELECTION_TYPE_WINDOW: * - * A #GdkAtom representing the WINDOW selection type. + * A #GdkAtom representing the `WINDOW` selection type. */ #define GDK_SELECTION_TYPE_WINDOW _GDK_MAKE_ATOM (33) /** * GDK_SELECTION_TYPE_STRING: * - * A #GdkAtom representing the STRING selection type. + * A #GdkAtom representing the `STRING` selection type. */ #define GDK_SELECTION_TYPE_STRING _GDK_MAKE_ATOM (31) diff --git a/gdk/gdktypes.h b/gdk/gdktypes.h index 02043a6f21..ce1c2da801 100644 --- a/gdk/gdktypes.h +++ b/gdk/gdktypes.h @@ -108,7 +108,7 @@ typedef struct _GdkAtom *GdkAtom; * GDK_NONE: * * A null value for #GdkAtom, used in a similar way as - * None in the Xlib API. + * `None` in the Xlib API. */ #define GDK_NONE _GDK_MAKE_ATOM (0) diff --git a/gdk/gdkwindow.c b/gdk/gdkwindow.c index 8bbe482a89..109b8434bd 100644 --- a/gdk/gdkwindow.c +++ b/gdk/gdkwindow.c @@ -10658,9 +10658,9 @@ gdk_property_get (GdkWindow *window, * must match the existing format or an error will occur. * @mode: a value describing how the new data is to be combined * with the current data. - * @data: the data (a guchar * - * gushort *, or gulong *, - * depending on @format), cast to a guchar *. + * @data: the data (a `guchar *` + * `gushort *`, or `gulong *`, + * depending on @format), cast to a `guchar *`. * @nelements: the number of elements of size determined by the format, * contained in @data. * diff --git a/gdk/wayland/gdkdisplay-wayland.c b/gdk/wayland/gdkdisplay-wayland.c index 03044657eb..4859877a2d 100644 --- a/gdk/wayland/gdkdisplay-wayland.c +++ b/gdk/wayland/gdkdisplay-wayland.c @@ -40,10 +40,10 @@ * @Title: Wayland Interaction * * The functions in this section are specific to the GDK Wayland backend. - * To use them, you need to include the <gdk/gdkwayland.h> + * To use them, you need to include the `<gdk/gdkwayland.h>` * header and use the Wayland-specific pkg-config files to build your - * application (either gdk-wayland-3.0 or - * gtk+-wayland-3.0). + * application (either `gdk-wayland-3.0` or + * `gtk+-wayland-3.0`). * * To make your code compile with other GDK backends, guard backend-specific * calls by an ifdef as follows. Since GDK may be built with multiple diff --git a/gdk/x11/gdkdisplay-x11.c b/gdk/x11/gdkdisplay-x11.c index fc6039cf4b..5a157a5648 100644 --- a/gdk/x11/gdkdisplay-x11.c +++ b/gdk/x11/gdkdisplay-x11.c @@ -2441,7 +2441,7 @@ gdk_x11_display_list_devices (GdkDisplay *display) * @n_events: number of event type codes to register * * Registers interest in receiving extension events with type codes - * between @event_base and event_base + n_events - 1. + * between @event_base and `event_base + n_events - 1`. * The registered events must have the window field in the same place * as core X events (this is not the case for e.g. XKB extension events). * @@ -2788,7 +2788,7 @@ gdk_x11_display_error_trap_pop_ignored (GdkDisplay *display) * @sm_client_id: the client id assigned by the session manager when the * connection was opened, or %NULL to remove the property. * - * Sets the SM_CLIENT_ID property on the application's leader window so that + * Sets the `SM_CLIENT_ID` property on the application's leader window so that * the window manager can save the application's state using the X11R6 ICCCM * session management protocol. * diff --git a/gdk/x11/gdkmain-x11.c b/gdk/x11/gdkmain-x11.c index b99e1fe2db..6447eb1d9d 100644 --- a/gdk/x11/gdkmain-x11.c +++ b/gdk/x11/gdkmain-x11.c @@ -52,10 +52,10 @@ * @Title: X Window System Interaction * * The functions in this section are specific to the GDK X11 backend. - * To use them, you need to include the <gdk/gdkx.h> + * To use them, you need to include the `<gdk/gdkx.h>` * header and use the X11-specific pkg-config files to build your - * application (either gdk-x11-3.0 or - * gtk+-x11-3.0). + * application (either `gdk-x11-3.0` or + * `gtk+-x11-3.0`). * * To make your code compile with other GDK backends, guard backend-specific * calls by an ifdef as follows. Since GDK may be built with multiple diff --git a/gtk/deprecated/gtkactiongroup.c b/gtk/deprecated/gtkactiongroup.c index b99644992a..22f9427391 100644 --- a/gtk/deprecated/gtkactiongroup.c +++ b/gtk/deprecated/gtkactiongroup.c @@ -48,7 +48,7 @@ * * Accelerators are handled by the GTK+ accelerator map. All actions are * assigned an accelerator path (which normally has the form - * <Actions>/group-name/action-name) + * `<Actions>/group-name/action-name`) * and a shortcut is associated with this accelerator path. All menuitems * and toolitems take on this accelerator path. The GTK+ accelerator map * code makes sure that the correct shortcut is displayed next to the menu @@ -918,7 +918,7 @@ check_unique_action (GtkActionGroup *action_group, * if a user tries to modify the accelerator of a menuitem associated with * the action. Therefore you must either set the accel path yourself with * gtk_action_set_accel_path(), or use - * gtk_action_group_add_action_with_accel (..., NULL). + * `gtk_action_group_add_action_with_accel (..., NULL)`. * * Since: 2.4 * @@ -965,7 +965,7 @@ gtk_action_group_add_action (GtkActionGroup *action_group, * with the stock_id of the action. * * Accel paths are set to - * <Actions>/group-name/action-name. + * `<Actions>/group-name/action-name`. * * Since: 2.4 * @@ -1110,7 +1110,7 @@ gtk_action_group_list_actions (GtkActionGroup *action_group) * * The "activate" signals of the actions are connected to the callbacks and * their accel paths are set to - * <Actions>/group-name/action-name. + * `<Actions>/group-name/action-name`. * * Since: 2.4 * @@ -1245,7 +1245,7 @@ gtk_action_group_add_actions_full (GtkActionGroup *action_group, * * The "activate" signals of the actions are connected to the callbacks and * their accel paths are set to - * <Actions>/group-name/action-name. + * `<Actions>/group-name/action-name`. * * Since: 2.4 * @@ -1365,7 +1365,7 @@ gtk_action_group_add_toggle_actions_full (GtkActionGroup *action_gro * * The "changed" signal of the first radio action is connected to the * @on_change callback and the accel paths of the actions are set to - * <Actions>/group-name/action-name. + * `<Actions>/group-name/action-name`. * * Since: 2.4 * diff --git a/gtk/deprecated/gtkrc.c b/gtk/deprecated/gtkrc.c index 67c6c47156..c6aac5f00c 100644 --- a/gtk/deprecated/gtkrc.c +++ b/gtk/deprecated/gtkrc.c @@ -100,7 +100,7 @@ * * For each RC file, in addition to the file itself, GTK+ will look for * a locale-specific file that will be parsed after the main file. - * For instance, if `LANG` is set to ja_JP.ujis, + * For instance, if `LANG` is set to `ja_JP.ujis`, * when loading the default file `~/.gtkrc` then GTK+ looks * for `~/.gtkrc.ja_JP` and `~/.gtkrc.ja`, * and parses the first of those that exists. @@ -109,44 +109,44 @@ * * A resource file defines a number of styles and key bindings and * attaches them to particular widgets. The attachment is done - * by the widget, widget_class, - * and class declarations. As an example + * by the `widget`, `widget_class`, + * and `class` declarations. As an example * of such a statement: * * |[ * widget "mywindow.*.GtkEntry" style "my-entry-class" * ]| * - * attaches the style "my-entry-class" to all + * attaches the style `"my-entry-class"` to all * widgets whose “widget path” matches the - * “pattern” "mywindow.*.GtkEntry". + * “pattern” `"mywindow.*.GtkEntry"`. * That is, all #GtkEntry widgets which are part of a #GtkWindow named - * "mywindow". + * `"mywindow"`. * * The patterns here are given in the standard shell glob syntax. - * The "?" wildcard matches any character, while - * "*" matches zero or more of any character. + * The `"?"` wildcard matches any character, while + * `"*"` matches zero or more of any character. * The three types of matching are against the widget path, the * “class path” and the class hierarchy. Both the - * widget path and the class path consist of a "." + * widget path and the class path consist of a `"."` * separated list of all the parents of the widget and the widget itself * from outermost to innermost. The difference is that in the widget path, * the name assigned by gtk_widget_set_name() is used if present, otherwise * the class name of the widget, while for the class path, the class name is * always used. * - * Since GTK+ 2.10, widget_class paths can also contain - * <classname> substrings, which are matching + * Since GTK+ 2.10, `widget_class` paths can also contain + * `<classname>` substrings, which are matching * the class with the given name and any derived classes. For instance, * |[ * widget_class "*<GtkMenuItem>.GtkLabel" style "my-style" * ]| * will match #GtkLabel widgets which are contained in any kind of menu item. * - * So, if you have a #GtkEntry named "myentry", inside of a - * horizontal box in a window named "mywindow", then the - * widget path is: "mywindow.GtkHBox.myentry" - * while the class path is: "GtkWindow.GtkHBox.GtkEntry". + * So, if you have a #GtkEntry named `"myentry"`, inside of a + * horizontal box in a window named `"mywindow"`, then the + * widget path is: `"mywindow.GtkHBox.myentry"` + * while the class path is: `"GtkWindow.GtkHBox.GtkEntry"`. * * Matching against class is a little different. The pattern match is done * against all class names in the widgets class hierarchy (not the layout @@ -162,24 +162,24 @@ * by order of specification (later overrides earlier). The priorities * that can be specified are (highest to lowest): * - * - highest + * - `highest` * - * - rc + * - `rc` * - * - theme + * - `theme` * - * - application + * - `application` * - * - gtk + * - `gtk` * - * - lowest + * - `lowest` * - * rc is the default for styles - * read from an RC file, theme + * `rc` is the default for styles + * read from an RC file, `theme` * is the default for styles read from theme RC files, - * application + * `application` * should be used for styles an application sets - * up, and gtk is used for styles + * up, and `gtk` is used for styles * that GTK+ creates internally. * * # Theme gtkrc files # @@ -230,46 +230,46 @@ * match to a single integer comparison in most cases. * * 4. To avoid complex recursive matching, specification of full class names - * (for class matches) or full path names (for - * widget and widget_class matches) + * (for `class` matches) or full path names (for + * `widget` and `widget_class` matches) * is to be preferred over shortened names - * containing "*" or "?". + * containing `"*"` or `"?"`. * * 5. If at all necessary, wildcards should only be used at the tail or head * of a pattern. This reduces the match complexity to a string comparison * per RC style. * - * 6. When using wildcards, use of "?" should be preferred - * over "*". This can reduce the matching complexity from - * O(n^2) to O(n). For example "Gtk*Box" can be turned into - * "Gtk?Box" and will still match #GtkHBox and #GtkVBox. + * 6. When using wildcards, use of `"?"` should be preferred + * over `"*"`. This can reduce the matching complexity from + * O(n^2) to O(n). For example `"Gtk*Box"` can be turned into + * `"Gtk?Box"` and will still match #GtkHBox and #GtkVBox. * - * 7. The use of "*" wildcards should be restricted as much - * as possible, because matching "A*B*C*RestString" can + * 7. The use of `"*"` wildcards should be restricted as much + * as possible, because matching `"A*B*C*RestString"` can * result in matching complexities of O(n^2) worst case. * * # Toplevel declarations # * * An RC file is a text file which is composed of a sequence - * of declarations. '#' characters delimit comments and - * the portion of a line after a '#' is ignored when parsing + * of declarations. `'#'` characters delimit comments and + * the portion of a line after a `'#'` is ignored when parsing * an RC file. * * The possible toplevel declarations are: * - * * binding name - * { ... } + * * `binding name + * { ... }` * * Declares a binding set. * - * * class pattern + * * `class pattern * [ style | binding ][ : priority ] - * name + * name` * * Specifies a style or binding set for a particular * branch of the inheritance hierarchy. * - * * include filename + * * `include filename` * * Parses another file at this point. If * filename is not an absolute filename, @@ -279,39 +279,39 @@ * locale-specific variant of * the included file. * - * * module_path path + * * `module_path path` * * Sets a path (a list of directories separated * by colons) that will be searched for theme engines referenced in * RC files. * - * * pixmap_path path + * * `pixmap_path path` * * Sets a path (a list of directories separated * by colons) that will be searched for pixmaps referenced in * RC files. * - * * im_module_file pathname + * * `im_module_file pathname` * * Sets the pathname for the IM modules file. Setting this from RC files * is deprecated; you should use the environment variable `GTK_IM_MODULE_FILE` * instead. * - * * style name [ = - * parent ] { ... } + * * `style name [ = + * parent ] { ... }` * * Declares a style. * - * * widget pattern + * * `widget pattern * [ style | binding ][ : priority ] - * name + * name` * * Specifies a style or binding set for a particular * group of widgets by matching on the widget pathname. * - * * widget_class pattern + * * `widget_class pattern * [ style | binding ][ : priority ] - * name + * name` * * Specifies a style or binding set for a particular * group of widgets by matching on the class pathname. @@ -324,127 +324,127 @@ * * # Styles # * - * A RC style is specified by a style + * A RC style is specified by a `style` * declaration in a RC file, and then bound to widgets - * with a widget, widget_class, - * or class declaration. All styles + * with a `widget`, `widget_class`, + * or `class` declaration. All styles * applying to a particular widget are composited together - * with widget declarations overriding - * widget_class declarations which, in - * turn, override class declarations. + * with `widget` declarations overriding + * `widget_class` declarations which, in + * turn, override `class` declarations. * Within each type of declaration, later declarations override * earlier ones. * - * Within a style declaration, the possible + * Within a `style` declaration, the possible * elements are: * - * * bg[state] = color + * * `bg[state] = color` * * Sets the color used for the background of most widgets. * - * * fg[state] = color + * * `fg[state] = color` * * Sets the color used for the foreground of most widgets. * - * * base[state] = color + * * `base[state] = color` * * Sets the color used for the background of widgets displaying * editable text. This color is used for the background * of, among others, #GtkText, #GtkEntry, #GtkList, and #GtkCList. * - * * text[state] = - * color + * * `text[state] = + * color` * * Sets the color used for foreground of widgets using - * base for the background color. + * `base` for the background color. * - * * xthickness = - * number + * * `xthickness = + * number` * * Sets the xthickness, which is used for various horizontal padding * values in GTK+. * - * * ythickness = - * number + * * `ythickness = + * number` * * Sets the ythickness, which is used for various vertical padding * values in GTK+. * - * * bg_pixmap[state] = - * pixmap + * * `bg_pixmap[state] = + * pixmap` * * Sets a background pixmap to be used in place of - * the bg color (or for #GtkText, - * in place of the base color. The special - * value "<parent>" may be used to indicate that the widget should + * the `bg` color (or for #GtkText, + * in place of the `base` color. The special + * value `"<parent>"` may be used to indicate that the widget should * use the same background pixmap as its parent. The special value - * "<none>" may be used to indicate no background pixmap. + * `"<none>"` may be used to indicate no background pixmap. - * * font = font + * * `font = font` * * Starting with GTK+ 2.0, the "font" and "fontset" * declarations are ignored; use "font_name" declarations instead. * - * * fontset = font + * * `fontset = font` * * Starting with GTK+ 2.0, the "font" and "fontset" * declarations are ignored; use "font_name" declarations instead. * - * * font_name = font + * * `font_name = font` * * Sets the font for a widget. font must be - * a Pango font name, e.g. "Sans Italic 10". + * a Pango font name, e.g. `"Sans Italic 10"`. * For details about Pango font names, see * pango_font_description_from_string(). * - * * stock["stock-id"] = { icon source specifications } + * * `stock["stock-id"] = { icon source specifications }` * * Defines the icon for a stock item. * - * * color["color-name"] = color specification + * * `color["color-name"] = color specification` * * Since 2.10, this element can be used to defines symbolic colors. See below for * the syntax of color specifications. * - * * engine "engine" { engine-specific - * settings } + * * `engine "engine" { engine-specific + * settings }` * * Defines the engine to be used when drawing with this style. * - * * class::property = value + * * `class::property = value` * * Sets a style property for a widget class. * * The colors and background pixmaps are specified as a function of the * state of the widget. The states are: * - * * NORMAL + * * `NORMAL` * * A color used for a widget in its normal state. * - * * ACTIVE + * * `ACTIVE` * - * A variant of the NORMAL color used when the + * A variant of the `NORMAL` color used when the * widget is in the %GTK_STATE_ACTIVE state, and also for * the trough of a ScrollBar, tabs of a NoteBook * other than the current tab and similar areas. * Frequently, this should be a darker variant - * of the NORMAL color. + * of the `NORMAL` color. * - * * PRELIGHT + * * `PRELIGHT` * * A color used for widgets in the %GTK_STATE_PRELIGHT state. This * state is the used for Buttons and MenuItems * that have the mouse cursor over them, and for * their children. * - * * SELECTED + * * `SELECTED` * * A color used to highlight data selected by the user. * for instance, the selected items in a list widget, and the * selection in an editable widget. * - * * INSENSITIVE + * * `INSENSITIVE` * * A color used for the background of widgets that have * been set insensitive with gtk_widget_set_sensitive(). @@ -452,18 +452,18 @@ * * Colors can be specified as a string containing a color name (GTK+ knows * all names from the X color database `/usr/lib/X11/rgb.txt`), - * in one of the hexadecimal forms #rrrrggggbbbb, - * #rrrgggbbb, #rrggbb, - * or #rgb, where r, - * g and b are + * in one of the hexadecimal forms `#rrrrggggbbbb`, + * `#rrrgggbbb`, `#rrggbb`, + * or `#rgb`, where `r`, + * `g` and `b` are * hex digits, or they can be specified as a triplet - * { r, g, - * b}, where r, - * g and b are either integers in + * `{ r, g, + * b}`, where `r`, + * `g` and `b` are either integers in * the range 0-65535 or floats in the range 0.0-1.0. * * Since 2.10, colors can also be specified by refering to a symbolic color, as - * follows: @color-name, or by using expressions to combine + * follows: `@color-name`, or by using expressions to combine * colors. The following expressions are currently supported: * * * mix (factor, color1, color2) @@ -483,12 +483,12 @@ * * lighter (color) * * This is an abbreviation for - * shade (1.3, color). + * `shade (1.3, color)`. * * * darker (color) * * This is an abbreviation for - * shade (0.7, color). + * `shade (0.7, color)`. * * Here are some examples of color expressions: * @@ -498,16 +498,16 @@ * lighter (@foreground) * ]| * - * In a stock definition, icon sources are specified as a + * In a `stock` definition, icon sources are specified as a * 4-tuple of image filename or icon name, text direction, widget state, and size, in that * order. Each icon source specifies an image filename or icon name to use with a given * direction, state, and size. Filenames are specified as a string such - * as "itemltr.png", while icon names (looked up + * as `"itemltr.png"`, while icon names (looked up * in the current icon theme), are specified with a leading - * @, such as @"item-ltr". - * The * character can be used as a + * `@`, such as `@"item-ltr"`. + * The `*` character can be used as a * wildcard, and if direction/state/size are omitted they default to - * *. So for example, the following specifies different icons to + * `*`. So for example, the following specifies different icons to * use for left-to-right and right-to-left languages: * * |[ @@ -539,9 +539,9 @@ * } * ]| * - * The sizes that come with GTK+ itself are "gtk-menu", - * "gtk-small-toolbar", "gtk-large-toolbar", - * "gtk-button", "gtk-dialog". Applications + * The sizes that come with GTK+ itself are `"gtk-menu"`, + * `"gtk-small-toolbar"`, `"gtk-large-toolbar"`, + * `"gtk-button"`, `"gtk-dialog"`. Applications * can define other sizes. * * It's also possible to use custom icons for a given state, for example: @@ -558,7 +558,7 @@ * When selecting an icon source to use, GTK+ will consider text direction most * important, state second, and size third. It will select the best match based on * those criteria. If an attribute matches exactly (e.g. you specified - * PRELIGHT or specified the size), GTK+ won't modify the image; + * `PRELIGHT` or specified the size), GTK+ won't modify the image; * if the attribute matches with a wildcard, GTK+ will scale or modify the image to * match the state and size the user requested. * @@ -582,41 +582,41 @@ * series of modifiers followed by the name of a key. The * modifiers can be: * - * - <alt> + * - `<alt>` * - * - <ctl> + * - `<ctl>` * - * - <control> + * - `<control>` * - * - <meta> + * - `<meta>` * - * - <hyper> + * - `<hyper>` * - * - <super> + * - `<super>` * - * - <mod1> + * - `<mod1>` * - * - <mod2> + * - `<mod2>` * - * - <mod3> + * - `<mod3>` * - * - <mod4> + * - `<mod4>` * - * - <mod5> + * - `<mod5>` * - * - <release> + * - `<release>` * - * - <shft> + * - `<shft>` * - * - <shift> + * - `<shift>` * - * <shft> is an alias for - * <shift>, - * <ctl> is an alias for - * <control>, + * `<shft>` is an alias for + * `<shift>`, + * `<ctl>` is an alias for + * `<control>`, * and - * <alt> is an alias for - * <mod1>. + * `<alt>` is an alias for + * `<mod1>`. * * The action that is bound to the key is a sequence * of signal names (strings) followed by parameters for diff --git a/gtk/deprecated/gtkstyle.c b/gtk/deprecated/gtkstyle.c index 1ae5da8343..802d4cef11 100644 --- a/gtk/deprecated/gtkstyle.c +++ b/gtk/deprecated/gtkstyle.c @@ -918,7 +918,7 @@ gtk_style_has_context (GtkStyle *style) * * Since this function may return a new object, you have to use it * in the following way: - * style = gtk_style_attach (style, window) + * `style = gtk_style_attach (style, window)` * * Returns: Either @style, or a newly-created #GtkStyle. * If the style is newly created, the style parameter diff --git a/gtk/deprecated/gtktable.c b/gtk/deprecated/gtktable.c index 55affca845..bfdef2fd27 100644 --- a/gtk/deprecated/gtktable.c +++ b/gtk/deprecated/gtktable.c @@ -805,7 +805,7 @@ gtk_table_attach (GtkTable *table, * As there are many options associated with gtk_table_attach(), this convenience * function provides the programmer with a means to add children to a table with * identical padding and expansion options. The values used for the #GtkAttachOptions - * are GTK_EXPAND | GTK_FILL, and the padding is set to 0. + * are `GTK_EXPAND | GTK_FILL`, and the padding is set to 0. * * Deprecated: 3.4: Use gtk_grid_attach() with #GtkGrid. Note that the attach * arguments differ between those two functions. diff --git a/gtk/deprecated/gtkuimanager.c b/gtk/deprecated/gtkuimanager.c index ddc844a192..53f87289e3 100644 --- a/gtk/deprecated/gtkuimanager.c +++ b/gtk/deprecated/gtkuimanager.c @@ -206,9 +206,9 @@ * Merging is done based on the names of the XML elements. Each element is * identified by a path which consists of the names of its anchestors, separated * by slashes. For example, the menuitem named "Left" in the example above - * has the path /ui/menubar/JustifyMenu/Left and the + * has the path `/ui/menubar/JustifyMenu/Left` and the * toolitem with the same name has path - * /ui/toolbar1/JustifyToolItems/Left. + * `/ui/toolbar1/JustifyToolItems/Left`. * * # Accelerators # * @@ -227,7 +227,7 @@ * can make it hard or impossible to determine in advance whether a separator * will end up in such an unfortunate position. * - * For separators in toolbars, you can set expand="true" to + * For separators in toolbars, you can set `expand="true"` to * turn them from a small, visible separator to an expanding, invisible one. * Toolitems following an expanding separator are effectively right-aligned. * diff --git a/gtk/gtkaboutdialog.c b/gtk/gtkaboutdialog.c index ab5b4af3dd..423ffbe871 100644 --- a/gtk/gtkaboutdialog.c +++ b/gtk/gtkaboutdialog.c @@ -67,8 +67,8 @@ * a program like its logo, name, copyright, website and license. It is * also possible to give credits to the authors, documenters, translators * and artists who have worked on the program. An about dialog is typically - * opened when the user selects the About option from - * the Help menu. All parts of the dialog are optional. + * opened when the user selects the `About` option from + * the `Help` menu. All parts of the dialog are optional. * * About dialogs often contain links and email addresses. GtkAboutDialog * displays these as clickable links. By default, it calls gtk_show_uri() @@ -79,7 +79,7 @@ * use the function gtk_show_about_dialog() which constructs and shows a dialog * and keeps it around so that it can be shown again. * - * Note that GTK+ sets a default title of _("About %s") + * Note that GTK+ sets a default title of `_("About %s")` * on the dialog window (where %s is replaced by the name of the * application, but in order to ensure proper translation of the title, * applications should set the title property explicitly when constructing diff --git a/gtk/gtkactionable.c b/gtk/gtkactionable.c index dfb33d084e..c5342fd1e0 100644 --- a/gtk/gtkactionable.c +++ b/gtk/gtkactionable.c @@ -228,8 +228,8 @@ gtk_actionable_set_action_target (GtkActionable *actionable, * the target is string-valued. * * @detailed_action_name is a string of the form - * "action::target" where action - * is the action name and target is the string to use + * `"action::target"` where `action` + * is the action name and `target` is the string to use * as the target. * * Since: 3.4 diff --git a/gtk/gtkactionmuxer.c b/gtk/gtkactionmuxer.c index 3a27649664..52b788f901 100644 --- a/gtk/gtkactionmuxer.c +++ b/gtk/gtkactionmuxer.c @@ -651,11 +651,11 @@ gtk_action_muxer_class_init (GObjectClass *class) * Adds the actions in @action_group to the list of actions provided by * @muxer. @prefix is prefixed to each action name, such that for each * action x in @action_group, there is an equivalent - * action @prefix.x in @muxer. + * action @prefix`.`x in @muxer. * - * For example, if @prefix is "app" and @action_group - * contains an action called "quit", then @muxer will - * now contain an action called "app.quit". + * For example, if @prefix is "`app`" and @action_group + * contains an action called "`quit`", then @muxer will + * now contain an action called "`app.quit`". * * If any #GtkActionObservers are registered for actions in the group, * "action_added" notifications will be emitted, as appropriate. diff --git a/gtk/gtkadjustment.c b/gtk/gtkadjustment.c index 52580ee02e..3173d2e37f 100644 --- a/gtk/gtkadjustment.c +++ b/gtk/gtkadjustment.c @@ -147,7 +147,7 @@ gtk_adjustment_class_init (GtkAdjustmentClass *class) * * The maximum value of the adjustment. * Note that values will be restricted by - * upper - page-size if the page-size + * `upper - page-size` if the page-size * property is nonzero. * * Since: 2.4 @@ -515,7 +515,7 @@ gtk_adjustment_get_upper (GtkAdjustment *adjustment) * Sets the maximum value of the adjustment. * * Note that values will be restricted by - * upper - page-size if the page-size + * `upper - page-size` if the page-size * property is nonzero. * * See gtk_adjustment_set_lower() about how to compress multiple diff --git a/gtk/gtkapplicationwindow.c b/gtk/gtkapplicationwindow.c index 6ee95b1f13..5156b29215 100644 --- a/gtk/gtkapplicationwindow.c +++ b/gtk/gtkapplicationwindow.c @@ -121,7 +121,7 @@ * * Attribute values can be translated using gettext, like other #GtkBuilder * content. `<attribute>` elements can be marked for - * translation with a translatable="yes" attribute. + * translation with a `translatable="yes"` attribute. * It is also possible to specify message context and translator comments, * using the context and comments attributes. To make use of this, the * #GtkBuilder must have been given the gettext domain to use. @@ -909,9 +909,9 @@ gtk_application_window_set_show_menubar (GtkApplicationWindow *window, * @window: a #GtkApplicationWindow * * Returns the unique ID of the window. If the window has not yet been added to - * a #GtkApplication, returns 0. + * a #GtkApplication, returns `0`. * - * Returns: the unique ID for @window, or 0 if the window + * Returns: the unique ID for @window, or `0` if the window * has not yet been added to a #GtkApplication * * Since: 3.6 diff --git a/gtk/gtkclipboard.c b/gtk/gtkclipboard.c index 69d13c8ffa..3bc6679140 100644 --- a/gtk/gtkclipboard.c +++ b/gtk/gtkclipboard.c @@ -328,8 +328,8 @@ clipboard_display_closed (GdkDisplay *display, * to the default clipboard, i.e. they copy the selection to what the * user sees as the clipboard. * - * (Passing #GDK_NONE is the same as using gdk_atom_intern - * ("CLIPBOARD", FALSE). See * http://www.freedesktop.org/Standards/clipboards-spec * for a detailed discussion of the "CLIPBOARD" vs. "PRIMARY" diff --git a/gtk/gtkcombobox.c b/gtk/gtkcombobox.c index ce3d72bf83..c887468474 100644 --- a/gtk/gtkcombobox.c +++ b/gtk/gtkcombobox.c @@ -803,8 +803,8 @@ gtk_combo_box_class_init (GtkComboBoxClass *klass) * The item which is currently active. If the model is a non-flat treemodel, * and the active item is not an immediate child of the root of the tree, * this property has the value - * gtk_tree_path_get_indices (path)[0], - * where path is the #GtkTreePath of the active item. + * `gtk_tree_path_get_indices (path)[0]`, + * where `path` is the #GtkTreePath of the active item. * * Since: 2.4 */ @@ -4258,8 +4258,8 @@ gtk_combo_box_set_column_span_column (GtkComboBox *combo_box, * Returns the index of the currently active item, or -1 if there's no * active item. If the model is a non-flat treemodel, and the active item * is not an immediate child of the root of the tree, this function returns - * gtk_tree_path_get_indices (path)[0], where - * path is the #GtkTreePath of the active item. + * `gtk_tree_path_get_indices (path)[0]`, where + * `path` is the #GtkTreePath of the active item. * * Return value: An integer which is the index of the currently active item, * or -1 if there's no active item. diff --git a/gtk/gtkcssprovider.c b/gtk/gtkcssprovider.c index 7f5843ce27..a030d1a34a 100644 --- a/gtk/gtkcssprovider.c +++ b/gtk/gtkcssprovider.c @@ -103,16 +103,16 @@ * various ways: * - To require that a widget satisfies several conditions, * combine several selectors into one by concatenating them. E.g. - * GtkButton#button1 matches a GtkButton widget + * `GtkButton#button1` matches a GtkButton widget * with the name button1. * - To only match a widget when it occurs inside some other * widget, write the two selectors after each other, separated by whitespace. - * E.g. GtkToolBar GtkButton matches GtkButton widgets + * E.g. `GtkToolBar GtkButton` matches GtkButton widgets * that occur inside a GtkToolBar. * - In the previous example, the GtkButton is matched even * if it occurs deeply nested inside the toolbar. To restrict the match * to direct children of the parent widget, insert a '>' character between - * the two selectors. E.g. GtkNotebook > GtkLabel matches + * the two selectors. E.g. `GtkNotebook > GtkLabel` matches * GtkLabel widgets that are direct children of a GtkNotebook. * * An example of widget classes and names in selectors: diff --git a/gtk/gtkdialog.c b/gtk/gtkdialog.c index 89f04e8150..722206a8b3 100644 --- a/gtk/gtkdialog.c +++ b/gtk/gtkdialog.c @@ -1044,7 +1044,7 @@ gtk_dialog_add_buttons (GtkDialog *dialog, * @response_id: a response ID * @setting: %TRUE for sensitive * - * Calls gtk_widget_set_sensitive (widget, @setting) + * Calls `gtk_widget_set_sensitive (widget, @setting)` * for each widget in the dialog's action area with the given @response_id. * A convenient way to sensitize/desensitize dialog buttons. **/ diff --git a/gtk/gtkentrycompletion.h b/gtk/gtkentrycompletion.h index a3fe584862..fd49aecdda 100644 --- a/gtk/gtkentrycompletion.h +++ b/gtk/gtkentrycompletion.h @@ -54,7 +54,7 @@ typedef struct _GtkEntryCompletionPrivate GtkEntryCompletionPrivate; * Note that @key is normalized and case-folded (see g_utf8_normalize() * and g_utf8_casefold()). If this is not appropriate, match functions * have access to the unmodified key via - * gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry ())). + * `gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry ()))`. * * Returns: %TRUE if @iter should be displayed as a possible completion * for @key diff --git a/gtk/gtkfilechooserwidget.c b/gtk/gtkfilechooserwidget.c index b3680385ad..4248000d2e 100644 --- a/gtk/gtkfilechooserwidget.c +++ b/gtk/gtkfilechooserwidget.c @@ -7178,7 +7178,7 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class) * ControlL * with a @path string of "" (the empty * string). It is also bound to / with a - * @path string of "/" + * @path string of "`/`" * (a slash): this lets you type / and * immediately type a path name. On Unix systems, this is bound to * ~ (tilde) with a path string diff --git a/gtk/gtkicontheme.c b/gtk/gtkicontheme.c index fd19e2ac8d..0b7f0782bb 100644 --- a/gtk/gtkicontheme.c +++ b/gtk/gtkicontheme.c @@ -73,7 +73,7 @@ * follows the Icon * Theme Specification. There is a default icon theme, - * named hicolor where applications should install + * named `hicolor` where applications should install * their icons, but more additional application themes can be * installed as operating system vendors and users choose. * diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c index 5d8a815f08..d52d8fdb78 100644 --- a/gtk/gtkiconview.c +++ b/gtk/gtkiconview.c @@ -2187,8 +2187,8 @@ gtk_icon_view_remove_editable (GtkCellArea *area, * it. Additionally, if @start_editing is %TRUE, then editing should be * started in the specified cell. * - * This function is often followed by gtk_widget_grab_focus - * (icon_view) in order to give keyboard focus to the widget. + * This function is often followed by `gtk_widget_grab_focus + * (icon_view)` in order to give keyboard focus to the widget. * Please note that editing can only happen when the widget is realized. * * Since: 2.8 diff --git a/gtk/gtklabel.c b/gtk/gtklabel.c index b9fda264b4..ca846faa04 100644 --- a/gtk/gtklabel.c +++ b/gtk/gtklabel.c @@ -95,7 +95,7 @@ * Labels may contain “mnemonics”. Mnemonics are * underlined characters in the label, used for keyboard navigation. * Mnemonics are created by providing a string with an underscore before - * the mnemonic character, such as "_File", to the + * the mnemonic character, such as `"_File"`, to the * functions gtk_label_new_with_mnemonic() or * gtk_label_set_text_with_mnemonic(). * diff --git a/gtk/gtklevelbar.c b/gtk/gtklevelbar.c index d9e443f4d1..a6f3639bb3 100644 --- a/gtk/gtklevelbar.c +++ b/gtk/gtklevelbar.c @@ -1367,7 +1367,7 @@ gtk_level_bar_remove_offset_value (GtkLevelBar *self, * Adds a new offset marker on @self at the position specified by @value. * When the bar value is in the interval topped by @value (or between @value * and #GtkLevelBar:max-value in case the offset is the last one on the bar) - * a style class named level-@name will be applied + * a style class named `level-`@name will be applied * when rendering the level bar fill. * If another offset marker named @name exists, its value will be * replaced by @value. diff --git a/gtk/gtkliststore.c b/gtk/gtkliststore.c index 5465eb1334..46e3ab891e 100644 --- a/gtk/gtkliststore.c +++ b/gtk/gtkliststore.c @@ -409,8 +409,8 @@ iter_is_valid (GtkTreeIter *iter, * in. Note that only types derived from standard GObject fundamental types * are supported. * - * As an example, gtk_list_store_new (3, G_TYPE_INT, G_TYPE_STRING, - * GDK_TYPE_PIXBUF); will create a new #GtkListStore with three columns, of type + * As an example, `gtk_list_store_new (3, G_TYPE_INT, G_TYPE_STRING, + * GDK_TYPE_PIXBUF);` will create a new #GtkListStore with three columns, of type * int, string and #GdkPixbuf respectively. * * Return value: a new #GtkListStore @@ -1166,8 +1166,8 @@ gtk_list_store_set_valist (GtkListStore *list_store, * The variable argument list should contain integer column numbers, * each column number followed by the value to be set. * The list is terminated by a -1. For example, to set column 0 with type - * %G_TYPE_STRING to "Foo", you would write gtk_list_store_set (store, iter, - * 0, "Foo", -1). + * %G_TYPE_STRING to "Foo", you would write `gtk_list_store_set (store, iter, + * 0, "Foo", -1)`. * * The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it * will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED. @@ -1679,7 +1679,7 @@ gtk_list_store_reorder_func (GSequenceIter *a, * @store: A #GtkListStore. * @new_order: (array zero-terminated=1): an array of integers mapping the new * position of each child to its old position before the re-ordering, - * i.e. @new_order[newpos] = oldpos. It must have + * i.e. @new_order`[newpos] = oldpos`. It must have * exactly as many items as the list store's length. * * Reorders @store to follow the order indicated by @new_order. Note that @@ -2165,7 +2165,7 @@ gtk_list_store_has_default_sort_func (GtkTreeSortable *sortable) * values given to this function. * * Calling - * gtk_list_store_insert_with_values (list_store, iter, position...) + * `gtk_list_store_insert_with_values (list_store, iter, position...)` * has the same effect as calling * |[ * gtk_list_store_insert (list_store, iter, position); diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c index 91966634d4..2324af5cf7 100644 --- a/gtk/gtkmain.c +++ b/gtk/gtkmain.c @@ -381,7 +381,7 @@ static gboolean do_setlocale = TRUE; * * Prevents gtk_init(), gtk_init_check(), gtk_init_with_args() and * gtk_parse_args() from automatically - * calling setlocale (LC_ALL, ""). You would + * calling `setlocale (LC_ALL, "")`. You would * want to use this function if you wanted to set the locale for * your program to something other than the user's locale, or if * you wanted to set different values for different locale categories. @@ -841,7 +841,7 @@ gtk_get_option_group (gboolean open_default_display) * understood by GTK+ are stripped before return. * @parameter_string: (allow-none): a string which is displayed in * the first line of `--help` output, after - * programname [OPTION...] + * `programname [OPTION...]` * @entries: (array zero-terminated=1): a %NULL-terminated array * of #GOptionEntrys describing the options of your program * @translation_domain: a translation domain to use for translating @@ -1015,7 +1015,7 @@ gtk_init_check (int *argc, * your program to fall back to a textual interface you want to * call gtk_init_check() instead. * - * Since 2.18, GTK+ calls signal (SIGPIPE, SIG_IGN) + * Since 2.18, GTK+ calls `signal (SIGPIPE, SIG_IGN)` * during initialization, to ignore SIGPIPE signals, since these are * almost never wanted in graphical applications. If you do need to * handle SIGPIPE for some reason, reset the handler after gtk_init(), diff --git a/gtk/gtkmenu.c b/gtk/gtkmenu.c index 978b9dd729..3b7f57be5e 100644 --- a/gtk/gtkmenu.c +++ b/gtk/gtkmenu.c @@ -2035,9 +2035,9 @@ gtk_menu_real_can_activate_accel (GtkWidget *widget, * purpose, automatically gets an accel path assigned. * * For example, a menu containing menu items "New" and "Exit", will, after - * gtk_menu_set_accel_path (menu, "<Gnumeric-Sheet>/File"); + * `gtk_menu_set_accel_path (menu, "<Gnumeric-Sheet>/File");` * has been called, assign its items the accel paths: - * "<Gnumeric-Sheet>/File/New" and "<Gnumeric-Sheet>/File/Exit". + * `"<Gnumeric-Sheet>/File/New"` and `"<Gnumeric-Sheet>/File/Exit"`. * * Assigning accel paths to menu items then enables the user to change * their accelerators at runtime. More details about accelerator paths diff --git a/gtk/gtkpaned.c b/gtk/gtkpaned.c index 856a5ba115..c9f1ea6105 100644 --- a/gtk/gtkpaned.c +++ b/gtk/gtkpaned.c @@ -1896,7 +1896,7 @@ gtk_paned_new (GtkOrientation orientation) * * Adds a child to the top or left pane with default parameters. This is * equivalent to - * gtk_paned_pack1 (paned, child, FALSE, TRUE). + * `gtk_paned_pack1 (paned, child, FALSE, TRUE)`. */ void gtk_paned_add1 (GtkPaned *paned, @@ -1912,7 +1912,7 @@ gtk_paned_add1 (GtkPaned *paned, * * Adds a child to the bottom or right pane with default parameters. This * is equivalent to - * gtk_paned_pack2 (paned, child, TRUE, TRUE). + * `gtk_paned_pack2 (paned, child, TRUE, TRUE)`. */ void gtk_paned_add2 (GtkPaned *paned, diff --git a/gtk/gtkprivate.c b/gtk/gtkprivate.c index 3177d4761d..fb1c6b57ee 100644 --- a/gtk/gtkprivate.c +++ b/gtk/gtkprivate.c @@ -71,7 +71,7 @@ _gtk_get_data_prefix (void) * * Return the Unix-style locale string for the language currently in * effect. On Unix systems, this is the return value from - * setlocale(LC_CTYPE, NULL), and the user can + * `setlocale(LC_CTYPE, NULL)`, and the user can * affect this through the environment variables LC_ALL, LC_CTYPE or * LANG (checked in that order). The locale strings typically is in * the form lang_COUNTRY, where lang is an ISO-639 language code, and diff --git a/gtk/gtksettings.c b/gtk/gtksettings.c index f3a14536be..88f29071ac 100644 --- a/gtk/gtksettings.c +++ b/gtk/gtksettings.c @@ -976,8 +976,8 @@ gtk_settings_class_init (GtkSettingsClass *class) * GtkSettings:gtk-print-preview-command: * * A command to run for displaying the print preview. The command - * should contain a %f placeholder, which will get replaced by - * the path to the pdf file. The command may also contain a %s + * should contain a `%f` placeholder, which will get replaced by + * the path to the pdf file. The command may also contain a `%s` * placeholder, which will get replaced by the path to a file * containing the print settings in the format produced by * gtk_print_settings_to_file(). @@ -2336,7 +2336,7 @@ G_GNUC_BEGIN_IGNORE_DEPRECATIONS * A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() * or gtk_widget_class_install_style_property_parser() which parses a * color given either by its name or in the form - * { red, green, blue } where red, green and + * `{ red, green, blue }` where red, green and * blue are integers between 0 and 65535 or floating-point numbers * between 0 and 1. * @@ -2477,7 +2477,7 @@ parse_flags_value (GScanner *scanner, * * Flags can be specified by their name, their nickname or * numerically. Multiple flags can be specified in the form - * "( flag1 | flag2 | ... )". + * `"( flag1 | flag2 | ... )"`. * * Return value: %TRUE if @gstring could be parsed and @property_value * has been set to the resulting flags value. @@ -2581,7 +2581,7 @@ get_braced_int (GScanner *scanner, * A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() * or gtk_widget_class_install_style_property_parser() which parses a * requisition in the form - * "{ width, height }" for integers %width and %height. + * `"{ width, height }"` for integers %width and %height. * * Return value: %TRUE if @gstring could be parsed and @property_value * has been set to the resulting #GtkRequisition. @@ -2622,7 +2622,7 @@ gtk_rc_property_parse_requisition (const GParamSpec *pspec, * A #GtkRcPropertyParser for use with gtk_settings_install_property_parser() * or gtk_widget_class_install_style_property_parser() which parses * borders in the form - * "{ left, right, top, bottom }" for integers + * `"{ left, right, top, bottom }"` for integers * left, right, top and bottom. * * Return value: %TRUE if @gstring could be parsed and @property_value diff --git a/gtk/gtksizegroup.c b/gtk/gtksizegroup.c index 0d495fee8f..11786694df 100644 --- a/gtk/gtksizegroup.c +++ b/gtk/gtksizegroup.c @@ -85,7 +85,7 @@ * ## GtkSizeGroup as GtkBuildable * * Size groups can be specified in a UI definition by placing an - * <object> element with class="GtkSizeGroup" + * <object> element with `class="GtkSizeGroup"` * somewhere in the UI definition. The widgets that belong to the * size group are specified by a <widgets> element that may * contain multiple <widget> elements, one for each member diff --git a/gtk/gtksocket.c b/gtk/gtksocket.c index 1388ddafe6..7dbb52cac5 100644 --- a/gtk/gtksocket.c +++ b/gtk/gtksocket.c @@ -304,7 +304,7 @@ gtk_socket_new (void) * client may be in the same process or in a different process. * * To embed a #GtkPlug in a #GtkSocket, you can either create the - * #GtkPlug with gtk_plug_new (0), call + * #GtkPlug with `gtk_plug_new (0)`, call * gtk_plug_get_id() to get the window ID of the plug, and then pass that to the * gtk_socket_add_id(), or you can call gtk_socket_get_id() to get the * window ID for the socket, and call gtk_plug_new() passing in that diff --git a/gtk/gtktextbuffer.h b/gtk/gtktextbuffer.h index e3f083ab91..614aa9c5d3 100644 --- a/gtk/gtktextbuffer.h +++ b/gtk/gtktextbuffer.h @@ -53,7 +53,7 @@ G_BEGIN_DECLS * lists returned by gtk_text_buffer_get_copy_target_list() and * gtk_text_buffer_get_paste_target_list(). * - * The values counts down from -1 to avoid clashes + * The values counts down from `-1` to avoid clashes * with application added drag destinations which usually start at 0. */ typedef enum diff --git a/gtk/gtktextiter.c b/gtk/gtktextiter.c index c46db9fb08..0110236279 100644 --- a/gtk/gtktextiter.c +++ b/gtk/gtktextiter.c @@ -406,7 +406,7 @@ gtk_text_iter_get_buffer (const GtkTextIter *iter) * * Creates a dynamically-allocated copy of an iterator. This function * is not useful in applications, because iterators can be copied with a - * simple assignment (GtkTextIter i = j;). The + * simple assignment (`GtkTextIter i = j;`). The * function is used by language bindings. * * Return value: a copy of the @iter, free with gtk_text_iter_free () @@ -449,7 +449,7 @@ gtk_text_iter_free (GtkTextIter *iter) * * Assigns the value of @other to @iter. This function * is not useful in applications, because iterators can be assigned - * with GtkTextIter i = j;. The + * with `GtkTextIter i = j;`. The * function is used by language bindings. * * Since: 3.2 diff --git a/gtk/gtktextview.c b/gtk/gtktextview.c index e684c7fed2..02b4d2c934 100644 --- a/gtk/gtktextview.c +++ b/gtk/gtktextview.c @@ -9502,7 +9502,7 @@ gtk_text_view_get_window (GtkTextView *text_view, * * Usually used to find out which window an event corresponds to. * If you connect to an event signal on @text_view, this function - * should be called on event->window to + * should be called on `event->window` to * see which window it was. * * Return value: the window type. diff --git a/gtk/gtktreemodel.c b/gtk/gtktreemodel.c index c0bfa03045..2aca8faddf 100644 --- a/gtk/gtktreemodel.c +++ b/gtk/gtktreemodel.c @@ -450,7 +450,7 @@ gtk_tree_model_base_init (gpointer g_class) * have been reordered, or %NULL if the depth of @path is 0 * @new_order: an array of integers mapping the current position * of each child to its old position before the re-ordering, - * i.e. @new_order[newpos] = oldpos + * i.e. @new_order`[newpos] = oldpos` * * This signal is emitted when the children of a node in the * #GtkTreeModel have been reordered. @@ -1122,7 +1122,7 @@ gtk_tree_path_down (GtkTreePath *path) * * This function is not intended for use in applications, * because you can just copy the structs by value - * (GtkTreeIter new_iter = iter;). + * (`GtkTreeIter new_iter = iter;`). * You must free this iter with gtk_tree_iter_free(). * * Return value: a newly-allocated copy of @iter @@ -1509,7 +1509,7 @@ gtk_tree_model_iter_previous (GtkTreeModel *tree_model, * function has been called. * * If @parent is %NULL returns the first node, equivalent to - * gtk_tree_model_get_iter_first (tree_model, iter); + * `gtk_tree_model_get_iter_first (tree_model, iter);` * * Return value: %TRUE, if @child has been set to the first child */ @@ -1728,8 +1728,8 @@ gtk_tree_model_unref_node (GtkTreeModel *tree_model, * each column number followed by a place to store the value being * retrieved. The list is terminated by a -1. For example, to get a * value from column 0 with type %G_TYPE_STRING, you would - * write: gtk_tree_model_get (model, iter, 0, &place_string_here, -1), - * where place_string_here is a #gchararray + * write: `gtk_tree_model_get (model, iter, 0, &place_string_here, -1)`, + * where `place_string_here` is a #gchararray * to be filled with the string. * * Returned values with type %G_TYPE_OBJECT have to be unreferenced, @@ -1899,7 +1899,7 @@ gtk_tree_model_row_deleted (GtkTreeModel *tree_model, * have been reordered, or %NULL if the depth of @path is 0 * @new_order: an array of integers mapping the current position of * each child to its old position before the re-ordering, - * i.e. @new_order[newpos] = oldpos + * i.e. @new_order`[newpos] = oldpos` * * Emits the #GtkTreeModel::rows-reordered signal on @tree_model. * @@ -1929,7 +1929,7 @@ gtk_tree_model_rows_reordered (GtkTreeModel *tree_model, * @new_order: (array length=length): an array of integers * mapping the current position of each child to its old * position before the re-ordering, - * i.e. @new_order[newpos] = oldpos + * i.e. @new_order`[newpos] = oldpos` * @length: length of @new_order array * * Emits the #GtkTreeModel::rows-reordered signal on @tree_model. diff --git a/gtk/gtktreesortable.h b/gtk/gtktreesortable.h index 848c2afb12..790ea083e4 100644 --- a/gtk/gtktreesortable.h +++ b/gtk/gtktreesortable.h @@ -75,7 +75,7 @@ typedef struct _GtkTreeSortableIface GtkTreeSortableIface; * * For example, if @model is a product catalogue, then a compare function * for the "price" column could be one which returns - * price_of(@a) - price_of(@b). + * `price_of(@a) - price_of(@b)`. * * Returns: a negative integer, zero or a positive integer depending on whether * @a sorts before, with or after @b diff --git a/gtk/gtktreestore.c b/gtk/gtktreestore.c index 5f02731d82..a9242f56bf 100644 --- a/gtk/gtktreestore.c +++ b/gtk/gtktreestore.c @@ -304,8 +304,8 @@ gtk_tree_store_init (GtkTreeStore *tree_store) * in. Note that only types derived from standard GObject fundamental types * are supported. * - * As an example, gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING, - * GDK_TYPE_PIXBUF); will create a new #GtkTreeStore with three columns, of type + * As an example, `gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING, + * GDK_TYPE_PIXBUF);` will create a new #GtkTreeStore with three columns, of type * #gint, #gchararray, and #GdkPixbuf respectively. * * Return value: a new #GtkTreeStore @@ -1170,7 +1170,7 @@ gtk_tree_store_set_valist (GtkTreeStore *tree_store, * each column number followed by the value to be set. * The list is terminated by a -1. For example, to set column 0 with type * %G_TYPE_STRING to "Foo", you would write - * gtk_tree_store_set (store, iter, 0, "Foo", -1). + * `gtk_tree_store_set (store, iter, 0, "Foo", -1)`. * * The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it * will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED. @@ -1494,7 +1494,7 @@ gtk_tree_store_insert_after (GtkTreeStore *tree_store, * the values given to this function. * * Calling - * gtk_tree_store_insert_with_values (tree_store, iter, position, ...) + * `gtk_tree_store_insert_with_values (tree_store, iter, position, ...)` * has the same effect as calling * |[ * gtk_tree_store_insert (tree_store, iter, position); @@ -2252,7 +2252,7 @@ gtk_tree_store_reorder_func (gconstpointer a, * @parent: A #GtkTreeIter. * @new_order: (array): an array of integers mapping the new position of each child * to its old position before the re-ordering, - * i.e. @new_order[newpos] = oldpos. + * i.e. @new_order`[newpos] = oldpos`. * * Reorders the children of @parent in @tree_store to follow the order * indicated by @new_order. Note that this function only works with diff --git a/gtk/gtktreeview.c b/gtk/gtktreeview.c index b9e26cb8ff..a119e0d414 100644 --- a/gtk/gtktreeview.c +++ b/gtk/gtktreeview.c @@ -81,7 +81,7 @@ * * Coordinate systems in GtkTreeView API: * - * - Widget coordinates: Coordinates relative to the widget (usually widget->window). + * - Widget coordinates: Coordinates relative to the widget (usually `widget->window`). * * - Bin window coordinates: Coordinates relative to the window that GtkTreeView renders to. * @@ -13325,7 +13325,7 @@ gtk_tree_view_set_cursor_on_cell (GtkTreeView *tree_view, * @tree_view: A #GtkTreeView * * Returns the window that @tree_view renders to. - * This is used primarily to compare to event->window + * This is used primarily to compare to `event->window` * to confirm that the event on @tree_view is on the right window. * * Return value: (transfer none): A #GdkWindow, or %NULL when @tree_view @@ -13352,8 +13352,8 @@ gtk_tree_view_get_bin_window (GtkTreeView *tree_view) * Finds the path at the point (@x, @y), relative to bin_window coordinates * (please see gtk_tree_view_get_bin_window()). * That is, @x and @y are relative to an events coordinates. @x and @y must - * come from an event on the @tree_view only where event->window == - * gtk_tree_view_get_bin_window (). It is primarily for + * come from an event on the @tree_view only where `event->window == + * gtk_tree_view_get_bin_window ()`. It is primarily for * things like popup menus. If @path is non-%NULL, then it will be filled * with the #GtkTreePath at that point. This path should be freed with * gtk_tree_path_free(). If @column is non-%NULL, then it will be filled @@ -13992,7 +13992,7 @@ gtk_tree_view_get_visible_range (GtkTreeView *tree_view, * * The @x and @y coordinate that are provided must be relative to bin_window * coordinates. That is, @x and @y must come from an event on @tree_view - * where event->window == gtk_tree_view_get_bin_window (). + * where `event->window == gtk_tree_view_get_bin_window ()`. * * For converting widget coordinates (eg. the ones you get from * GtkWidget::query-tooltip), please see diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c index 0f2dca5900..e792fdefec 100644 --- a/gtk/gtkwidget.c +++ b/gtk/gtkwidget.c @@ -4114,8 +4114,8 @@ gtk_widget_thaw_child_notify (GtkWidget *widget) * * This is a convenience function for creating a widget and setting * its properties in one go. For example you might write: - * gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign", - * 0.0, NULL) to create a left-aligned label. Equivalent to + * `gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign", + * 0.0, NULL)` to create a left-aligned label. Equivalent to * g_object_new(), but returns a widget so you don't have to * cast the object yourself. * @@ -10734,7 +10734,7 @@ gtk_widget_add_device_events (GtkWidget *widget, * returned widget; it should not be unreferenced. * * Note the difference in behavior vs. gtk_widget_get_ancestor(); - * gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW) + * `gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)` * would return * %NULL if @widget wasn't inside a toplevel window, and if the * window was inside a #GtkWindow-derived widget which was in turn @@ -10773,7 +10773,7 @@ gtk_widget_get_toplevel (GtkWidget *widget) * @widget_type: ancestor type * * Gets the first ancestor of @widget with type @widget_type. For example, - * gtk_widget_get_ancestor (widget, GTK_TYPE_BOX) gets + * `gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)` gets * the first #GtkBox that's an ancestor of @widget. No reference will be * added to the returned widget; it should not be unreferenced. See note * about checking for a toplevel #GtkWindow in the docs for @@ -14409,8 +14409,8 @@ gtk_widget_get_clipboard (GtkWidget *widget, GdkAtom selection) * The widgets in the list are not individually referenced. If you * want to iterate through the list and perform actions involving * callbacks that might destroy the widgets, you - * must call g_list_foreach (result, - * (GFunc)g_object_ref, NULL) first, and then unref all the + * must call `g_list_foreach (result, + * (GFunc)g_object_ref, NULL)` first, and then unref all the * widgets afterwards. * Return value: (element-type GtkWidget) (transfer container): the list of diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c index a0377ce9ab..e21ba39889 100644 --- a/gtk/gtkwindow.c +++ b/gtk/gtkwindow.c @@ -2511,7 +2511,7 @@ gtk_window_activate_focus (GtkWindow *window) * Retrieves the current focused widget within the window. * Note that this is the widget that would have the focus * if the toplevel window focused; if the toplevel window - * is not focused then gtk_widget_has_focus (widget) will + * is not focused then `gtk_widget_has_focus (widget)` will * not be %TRUE for the widget. * * Return value: (transfer none): the currently focused widget, or %NULL if there is none. @@ -2629,7 +2629,7 @@ gtk_window_get_modal (GtkWindow *window) * in the list are not individually referenced. If you want * to iterate through the list and perform actions involving * callbacks that might destroy the widgets, you must call - * g_list_foreach (result, (GFunc)g_object_ref, NULL) first, and + * `g_list_foreach (result, (GFunc)g_object_ref, NULL)` first, and * then unref all the widgets afterwards. * * Return value: (element-type GtkWidget) (transfer container): list of toplevel widgets @@ -4949,8 +4949,8 @@ gtk_window_get_size (GtkWindow *window, * the bottom-right corner of the window border will be placed at that * reference point. So, to place a window in the bottom right corner * you would first set gravity to south east, then write: - * gtk_window_move (window, gdk_screen_width () - window_width, - * gdk_screen_height () - window_height) (note that this + * `gtk_window_move (window, gdk_screen_width () - window_width, + * gdk_screen_height () - window_height)` (note that this * example does not take multi-head scenarios into account). * * The Extended Window Manager Hints specification at