diff options
author | William Jon McCann <william.jon.mccann@gmail.com> | 2014-02-04 18:21:13 -0500 |
---|---|---|
committer | William Jon McCann <william.jon.mccann@gmail.com> | 2014-02-04 18:24:29 -0500 |
commit | a22358c0c0ed5d9c946816c4212d534ef5f6f378 (patch) | |
tree | 8efa5819f62833c01a95bedfade1fe51809dd87a /gdk | |
parent | 76447c3512f083a11e716d10ade774ade929b2dd (diff) | |
download | gtk+-a22358c0c0ed5d9c946816c4212d534ef5f6f378.tar.gz |
docs: use ` instead of <literal>
Diffstat (limited to 'gdk')
-rw-r--r-- | gdk/gdk.c | 4 | ||||
-rw-r--r-- | gdk/gdkcolor.c | 4 | ||||
-rw-r--r-- | gdk/gdkcursor.c | 4 | ||||
-rw-r--r-- | gdk/gdkdisplaymanager.c | 4 | ||||
-rw-r--r-- | gdk/gdkevents.c | 6 | ||||
-rw-r--r-- | gdk/gdkevents.h | 6 | ||||
-rw-r--r-- | gdk/gdkkeys.c | 12 | ||||
-rw-r--r-- | gdk/gdkrgba.c | 4 | ||||
-rw-r--r-- | gdk/gdkselection.c | 6 | ||||
-rw-r--r-- | gdk/gdkselection.h | 32 | ||||
-rw-r--r-- | gdk/gdktypes.h | 2 | ||||
-rw-r--r-- | gdk/gdkwindow.c | 6 | ||||
-rw-r--r-- | gdk/wayland/gdkdisplay-wayland.c | 6 | ||||
-rw-r--r-- | gdk/x11/gdkdisplay-x11.c | 4 | ||||
-rw-r--r-- | gdk/x11/gdkmain-x11.c | 6 |
15 files changed, 53 insertions, 53 deletions
@@ -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 <literal>exit(1)</literal>. + * 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 <literal>WM_CLASS</literal> 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 - * <literal>#rrrrggggbbbb</literal>, where <literal>r</literal>, - * <literal>g</literal> and <literal>b</literal> 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 <literal>-1</literal>, 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 <literal>0</literal> 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 - * <literal>gdk_display_manager_get_default_display (gdk_display_manager_get ())</literal>. + * 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 <literal>event->any.window</literal>, 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 <literal>event->motion.x_root</literal> and - * <literal>event->motion.y_root</literal> 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 <literal>event</literal> 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 - * <literal>event->window</literal>. 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 <literal>Gdk.EventType.2ButtonPress</literal>, 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 <literal>plus</literal> + * instance, on a US keyboard, the `plus` * symbol is shifted, so when comparing a key press to a - * <literal><Control>plus</literal> accelerator <Shift> should + * `<Control>plus` accelerator <Shift> should * be masked out. * * |[<!-- language="C" --> @@ -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, <literal><Control></literal> - * would be masked out even if only <literal><Control><Alt></literal> + * 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 <literal><Control>plus</literal>, - * not <literal><Control><Shift>plus</literal>, + * 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 - * <literal>rgb (r, g, b)</literal> or - * <literal>rgba (r, g, b, a)</literal>, + * `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 - * <literal>PRIMARY</literal> and <literal>CLIPBOARD</literal>. + * `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 <literal>TARGETS</literal>. 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 <link linkend="gdk3-Properties-and-Atoms">Properties and Atoms</link> @@ -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 - * <literal>gtkselection.h</literal> 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 <literal>PRIMARY</literal> selection. + * A #GdkAtom representing the `PRIMARY` selection. */ #define GDK_SELECTION_PRIMARY _GDK_MAKE_ATOM (1) /** * GDK_SELECTION_SECONDARY: * - * A #GdkAtom representing the <literal>SECONDARY</literal> selection. + * A #GdkAtom representing the `SECONDARY` selection. */ #define GDK_SELECTION_SECONDARY _GDK_MAKE_ATOM (2) /** * GDK_SELECTION_CLIPBOARD: * - * A #GdkAtom representing the <literal>CLIPBOARD</literal> selection. + * A #GdkAtom representing the `CLIPBOARD` selection. */ #define GDK_SELECTION_CLIPBOARD _GDK_MAKE_ATOM (69) /** * GDK_TARGET_BITMAP: * - * A #GdkAtom representing the <literal>BITMAP</literal> selection target. + * A #GdkAtom representing the `BITMAP` selection target. */ #define GDK_TARGET_BITMAP _GDK_MAKE_ATOM (5) /** * GDK_TARGET_COLORMAP: * - * A #GdkAtom representing the <literal>COLORMAP</literal> selection target. + * A #GdkAtom representing the `COLORMAP` selection target. */ #define GDK_TARGET_COLORMAP _GDK_MAKE_ATOM (7) /** * GDK_TARGET_DRAWABLE: * - * A #GdkAtom representing the <literal>DRAWABLE</literal> selection target. + * A #GdkAtom representing the `DRAWABLE` selection target. */ #define GDK_TARGET_DRAWABLE _GDK_MAKE_ATOM (17) /** * GDK_TARGET_PIXMAP: * - * A #GdkAtom representing the <literal>PIXMAP</literal> selection target. + * A #GdkAtom representing the `PIXMAP` selection target. */ #define GDK_TARGET_PIXMAP _GDK_MAKE_ATOM (20) /** * GDK_TARGET_STRING: * - * A #GdkAtom representing the <literal>STRING</literal> 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 <literal>ATOM</literal> 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 <literal>BITMAP</literal> 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 <literal>COLORMAP</literal> 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 <literal>DRAWABLE</literal> 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 <literal>INTEGER</literal> 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 <literal>PIXMAP</literal> 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 <literal>WINDOW</literal> 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 <literal>STRING</literal> 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 - * <literal>None</literal> 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 <literal>guchar *</literal> - * <literal>gushort *</literal>, or <literal>gulong *</literal>, - * depending on @format), cast to a <literal>guchar *</literal>. + * @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 <literal><gdk/gdkwayland.h></literal> + * 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 <literal>gdk-wayland-3.0</literal> or - * <literal>gtk+-wayland-3.0</literal>). + * 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 <literal>event_base + n_events - 1</literal>. + * 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 <literal>SM_CLIENT_ID</literal> 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 <literal><gdk/gdkx.h></literal> + * 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 <literal>gdk-x11-3.0</literal> or - * <literal>gtk+-x11-3.0</literal>). + * 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 |