Commit a22358c0 authored by William Jon McCann's avatar William Jon McCann
Browse files

docs: use ` instead of <literal>

parent 76447c35
......@@ -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
......
......@@ -164,8 +164,8 @@ gdk_color_parse (const gchar *spec,
* @color: a #GdkColor
*
* Returns a textual specification of @color in the hexadecimal form
* <literal>&num;rrrrggggbbbb</literal>, where <literal>r</literal>,
* <literal>g</literal> and <literal>b</literal> are hex digits
* `&num;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().
......
......@@ -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
......
......@@ -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.
......
......@@ -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
*
......
......@@ -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.
......
......@@ -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>&lt;Control&gt;plus</literal> accelerator &lt;Shift&gt; should
* `&lt;Control&gt;plus` accelerator &lt;Shift&gt; 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>&lt;Control&gt;</literal>
* would be masked out even if only <literal>&lt;Control&gt;&lt;Alt&gt;</literal>
* used in the keymap, since, for instance, `&lt;Control&gt;`
* would be masked out even if only `&lt;Control&gt;&lt;Alt&gt;`
* 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>&lt;Control&gt;plus</literal>,
* not <literal>&lt;Control&gt;&lt;Shift&gt;plus</literal>,
* removed. Store `&lt;Control&gt;plus`,
* not `&lt;Control&gt;&lt;Shift&gt;plus`,
*
* Return value: %TRUE if there was a keyval bound to the keycode/state/group
**/
......
......@@ -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
......
......@@ -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).
......
......@@ -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)
......
......@@ -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)
......
......@@ -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.
*
......
......@@ -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>&lt;gdk/gdkwayland.h&gt;</literal>
* To use them, you need to include the `&lt;gdk/gdkwayland.h&gt;`
* 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
......
......@@ -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.
*
......
......@@ -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>&lt;gdk/gdkx.h&gt;</literal>
* To use them, you need to include the `&lt;gdk/gdkx.h&gt;`
* 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
......
......@@ -48,7 +48,7 @@
*
* Accelerators are handled by the GTK+ accelerator map. All actions are
* assigned an accelerator path (which normally has the form
* <literal>&lt;Actions&gt;/group-name/action-name</literal>)
* `&lt;Actions&gt;/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
* <literal>gtk_action_group_add_action_with_accel (..., NULL)</literal>.
* `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
* <literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
* `&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable>`.
*
* 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
* <literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
* `&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable>`.
*
* 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
* <literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
* `&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable>`.
*
* 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
* <literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
* `&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable>`.
*
* Since: 2.4
*
......
This diff is collapsed.
......@@ -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:
* <literal>style = gtk_style_attach (style, window)</literal>
* `style = gtk_style_attach (style, window)`
*
* Returns: Either @style, or a newly-created #GtkStyle.
* If the style is newly created, the style parameter
......
......@@ -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 <literal>GTK_EXPAND | GTK_FILL</literal>, 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.
......
......@@ -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 <literal>/ui/menubar/JustifyMenu/Left</literal> and the
* has the path `/ui/menubar/JustifyMenu/Left` and the
* toolitem with the same name has path
* <literal>/ui/toolbar1/JustifyToolItems/Left</literal>.
* `/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 <literal>expand="true"</literal> 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.
*
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment