Commit 22586ea7 authored by William Jon McCann's avatar William Jon McCann

docs: use #*-struct instead of <structname>

parent 8418e642
...@@ -47,7 +47,7 @@ ...@@ -47,7 +47,7 @@
* gdk_color_copy: * gdk_color_copy:
* @color: a #GdkColor * @color: a #GdkColor
* *
* Makes a copy of a color structure. * Makes a copy of a #GdkColor.
* *
* The result must be freed using gdk_color_free(). * The result must be freed using gdk_color_free().
* *
...@@ -69,7 +69,7 @@ gdk_color_copy (const GdkColor *color) ...@@ -69,7 +69,7 @@ gdk_color_copy (const GdkColor *color)
* gdk_color_free: * gdk_color_free:
* @color: a #GdkColor * @color: a #GdkColor
* *
* Frees a color structure created with gdk_color_copy(). * Frees a #GdkColor created with gdk_color_copy().
*/ */
void void
gdk_color_free (GdkColor *color) gdk_color_free (GdkColor *color)
...@@ -129,8 +129,7 @@ G_DEFINE_BOXED_TYPE (GdkColor, gdk_color, ...@@ -129,8 +129,7 @@ G_DEFINE_BOXED_TYPE (GdkColor, gdk_color,
* *
* Parses a textual specification of a color and fill in the * Parses a textual specification of a color and fill in the
* <structfield>red</structfield>, <structfield>green</structfield>, * <structfield>red</structfield>, <structfield>green</structfield>,
* and <structfield>blue</structfield> fields of a #GdkColor * and <structfield>blue</structfield> fields of a #GdkColor.
* structure.
* *
* The string can either one of a large set of standard names * The string can either one of a large set of standard names
* (taken from the X11 <filename>rgb.txt</filename> file), or * (taken from the X11 <filename>rgb.txt</filename> file), or
......
...@@ -46,7 +46,7 @@ G_BEGIN_DECLS ...@@ -46,7 +46,7 @@ G_BEGIN_DECLS
* @green: The green component of the color * @green: The green component of the color
* @blue: The blue component of the color * @blue: The blue component of the color
* *
* The #GdkColor structure is used to describe a color, * A #GdkColor is used to describe a color,
* similar to the XColor struct used in the X11 drawing API. * similar to the XColor struct used in the X11 drawing API.
*/ */
struct _GdkColor struct _GdkColor
......
...@@ -54,13 +54,13 @@ ...@@ -54,13 +54,13 @@
* Cursors by themselves are not very interesting, they must be be * Cursors by themselves are not very interesting, they must be be
* bound to a window for users to see them. This is done with * bound to a window for users to see them. This is done with
* gdk_window_set_cursor() or by setting the cursor member of the * gdk_window_set_cursor() or by setting the cursor member of the
* #GdkWindowAttr struct passed to gdk_window_new(). * #GdkWindowAttr passed to gdk_window_new().
*/ */
/** /**
* GdkCursor: * GdkCursor:
* *
* The #GdkCursor structure represents a cursor. Its contents are private. * A #GdkCursor represents a cursor. Its contents are private.
*/ */
enum { enum {
......
...@@ -134,7 +134,7 @@ typedef enum { ...@@ -134,7 +134,7 @@ typedef enum {
* @time: The timestamp for this event. * @time: The timestamp for this event.
* @axes: the values of the device's axes. * @axes: the values of the device's axes.
* *
* The #GdkTimeCoord structure stores a single event in a motion history. * A #GdkTimeCoord stores a single event in a motion history.
*/ */
struct _GdkTimeCoord struct _GdkTimeCoord
{ {
......
...@@ -43,7 +43,7 @@ G_BEGIN_DECLS ...@@ -43,7 +43,7 @@ G_BEGIN_DECLS
* @Short_description: Data structures specific to each type of event * @Short_description: Data structures specific to each type of event
* @Title: Event Structures * @Title: Event Structures
* *
* The event structs contain data specific to each type of event in GDK. * The event structures contain data specific to each type of event in GDK.
* *
* <note> * <note>
* <para> * <para>
...@@ -1154,10 +1154,10 @@ struct _GdkEventDND { ...@@ -1154,10 +1154,10 @@ struct _GdkEventDND {
* @setting: a #GdkEventSetting * @setting: a #GdkEventSetting
* @grab_broken: a #GdkEventGrabBroken * @grab_broken: a #GdkEventGrabBroken
* *
* The #GdkEvent struct contains a union of all of the event structs, * A #GdkEvent contains a union of all of the event types,
* and allows access to the data fields in a number of ways. * and allows access to the data fields in a number of ways.
* *
* The event type is always the first field in all of the event structs, and * The event type is always the first field in all of the event types, and
* can always be accessed with the following code, no matter what type of * can always be accessed with the following code, no matter what type of
* event it is: * event it is:
* <informalexample> * <informalexample>
...@@ -1169,8 +1169,8 @@ struct _GdkEventDND { ...@@ -1169,8 +1169,8 @@ struct _GdkEventDND {
* </programlisting> * </programlisting>
* </informalexample> * </informalexample>
* *
* To access other fields of the event structs, the pointer to the event * To access other fields of the event, the pointer to the event
* can be cast to the appropriate event struct pointer, or the union member * can be cast to the appropriate event type, or the union member
* name can be used. For example if the event type is %GDK_BUTTON_PRESS * name can be used. For example if the event type is %GDK_BUTTON_PRESS
* then the x coordinate of the button press can be accessed with: * then the x coordinate of the button press can be accessed with:
* <informalexample> * <informalexample>
......
...@@ -36,9 +36,9 @@ ...@@ -36,9 +36,9 @@
* and sets of pixels on the screen. Together with Cairo's #cairo_region_t data * and sets of pixels on the screen. Together with Cairo's #cairo_region_t data
* type, they make up the central types for representing graphical data. * type, they make up the central types for representing graphical data.
* *
* #GdkPoint is a simple structure containing an x and y coordinate of a point. * A #GdkPoint represents an x and y coordinate of a point.
* *
* #GdkRectangle is a structure holding the position and size of a rectangle. * A #GdkRectangle represents the position and size of a rectangle.
* The intersection of two rectangles can be computed with * The intersection of two rectangles can be computed with
* gdk_rectangle_intersect(). To find the union of two rectangles use * gdk_rectangle_intersect(). To find the union of two rectangles use
* gdk_rectangle_union(). * gdk_rectangle_union().
......
...@@ -35,7 +35,7 @@ ...@@ -35,7 +35,7 @@
* @Short_description: RGBA colors * @Short_description: RGBA colors
* @Title: RGBA Colors * @Title: RGBA Colors
* *
* The #GdkRGBA struct is a convenient way to pass rgba colors around. * #GdkRGBA is a convenient way to pass rgba colors around.
* It's based on cairo's way to deal with colors and mirrors its behavior. * It's based on cairo's way to deal with colors and mirrors its behavior.
* All values are in the range from 0.0 to 1.0 inclusive. So the color * All values are in the range from 0.0 to 1.0 inclusive. So the color
* (0.0, 0.0, 0.0, 0.0) represents transparent black and * (0.0, 0.0, 0.0, 0.0) represents transparent black and
...@@ -54,7 +54,7 @@ G_DEFINE_BOXED_TYPE (GdkRGBA, gdk_rgba, ...@@ -54,7 +54,7 @@ G_DEFINE_BOXED_TYPE (GdkRGBA, gdk_rgba,
* @alpha: The opacity of the color from 0.0 for completely translucent to * @alpha: The opacity of the color from 0.0 for completely translucent to
* 1.0 for opaque * 1.0 for opaque
* *
* The GdkRGBA structure is used to represent a (possibly translucent) * A #GdkRGBA is used to represent a (possibly translucent)
* color, in a way that is compatible with cairos notion of color. * color, in a way that is compatible with cairos notion of color.
*/ */
...@@ -62,7 +62,7 @@ G_DEFINE_BOXED_TYPE (GdkRGBA, gdk_rgba, ...@@ -62,7 +62,7 @@ G_DEFINE_BOXED_TYPE (GdkRGBA, gdk_rgba,
* gdk_rgba_copy: * gdk_rgba_copy:
* @rgba: a #GdkRGBA * @rgba: a #GdkRGBA
* *
* Makes a copy of a #GdkRGBA structure. * Makes a copy of a #GdkRGBA.
* *
* The result must be freed through gdk_rgba_free(). * The result must be freed through gdk_rgba_free().
* *
...@@ -80,7 +80,7 @@ gdk_rgba_copy (const GdkRGBA *rgba) ...@@ -80,7 +80,7 @@ gdk_rgba_copy (const GdkRGBA *rgba)
* gdk_rgba_free: * gdk_rgba_free:
* @rgba: a #GdkRGBA * @rgba: a #GdkRGBA
* *
* Frees a #GdkRGBA struct created with gdk_rgba_copy() * Frees a #GdkRGBA created with gdk_rgba_copy()
* *
* Since: 3.0 * Since: 3.0
*/ */
...@@ -134,13 +134,13 @@ parse_rgb_value (const gchar *str, ...@@ -134,13 +134,13 @@ parse_rgb_value (const gchar *str,
/** /**
* gdk_rgba_parse: * gdk_rgba_parse:
* @rgba: the #GdkRGBA struct to fill in * @rgba: the #GdkRGBA to fill in
* @spec: the string specifying the color * @spec: the string specifying the color
* *
* Parses a textual representation of a color, filling in * Parses a textual representation of a color, filling in
* the <structfield>red</structfield>, <structfield>green</structfield>, * the <structfield>red</structfield>, <structfield>green</structfield>,
* <structfield>blue</structfield> and <structfield>alpha</structfield> * <structfield>blue</structfield> and <structfield>alpha</structfield>
* fields of the @rgba struct. * fields of the @rgba #GdkRGBA.
* *
* The string can be either one of: * The string can be either one of:
* <itemizedlist> * <itemizedlist>
......
...@@ -75,7 +75,7 @@ typedef enum ...@@ -75,7 +75,7 @@ typedef enum
/** /**
* GdkVisual: * GdkVisual:
* *
* The #GdkVisual structure contains information about * A #GdkVisual contains information about
* a particular visual. * a particular visual.
*/ */
......
...@@ -1815,7 +1815,7 @@ gtk_rc_parse_priority (GScanner *scanner, ...@@ -1815,7 +1815,7 @@ gtk_rc_parse_priority (GScanner *scanner,
/** /**
* gtk_rc_parse_color: * gtk_rc_parse_color:
* @scanner: a #GScanner * @scanner: a #GScanner
* @color: (out): a pointer to a #GdkColor structure in which to store * @color: (out): a pointer to a #GdkColor in which to store
* the result * the result
* *
* Parses a color in the format expected * Parses a color in the format expected
...@@ -1840,7 +1840,7 @@ gtk_rc_parse_color (GScanner *scanner, ...@@ -1840,7 +1840,7 @@ gtk_rc_parse_color (GScanner *scanner,
* gtk_rc_parse_color_full: * gtk_rc_parse_color_full:
* @scanner: a #GScanner * @scanner: a #GScanner
* @style: (allow-none): a #GtkRcStyle, or %NULL * @style: (allow-none): a #GtkRcStyle, or %NULL
* @color: (out): a pointer to a #GdkColor structure in which to store * @color: (out): a pointer to a #GdkColor in which to store
* the result * the result
* *
* Parses a color in the format expected * Parses a color in the format expected
......
...@@ -74,10 +74,10 @@ typedef enum ...@@ -74,10 +74,10 @@ typedef enum
* @xthickness: X thickness * @xthickness: X thickness
* @ythickness: Y thickness * @ythickness: Y thickness
* *
* The #GtkRcStyle structure is used to represent a set * The #GtkRcStyle-struct is used to represent a set
* of information about the appearance of a widget. * of information about the appearance of a widget.
* This can later be composited together with other * This can later be composited together with other
* #GtkRcStyle structures to form a #GtkStyle. * #GtkRcStyle-struct<!-- -->s to form a #GtkStyle.
*/ */
struct _GtkRcStyle struct _GtkRcStyle
{ {
......
...@@ -4187,14 +4187,14 @@ gtk_widget_get_style (GtkWidget *widget) ...@@ -4187,14 +4187,14 @@ gtk_widget_get_style (GtkWidget *widget)
/** /**
* gtk_widget_modify_style: * gtk_widget_modify_style:
* @widget: a #GtkWidget * @widget: a #GtkWidget
* @style: the #GtkRcStyle holding the style modifications * @style: the #GtkRcStyle-struct holding the style modifications
* *
* Modifies style values on the widget. * Modifies style values on the widget.
* *
* Modifications made using this technique take precedence over * Modifications made using this technique take precedence over
* style values set via an RC file, however, they will be overridden * style values set via an RC file, however, they will be overridden
* if a style is explicitly set on the widget using gtk_widget_set_style(). * if a style is explicitly set on the widget using gtk_widget_set_style().
* The #GtkRcStyle structure is designed so each field can either be * The #GtkRcStyle-struct is designed so each field can either be
* set or unset, so it is possible, using this function, to modify some * set or unset, so it is possible, using this function, to modify some
* style values and leave the others unchanged. * style values and leave the others unchanged.
* *
......
...@@ -89,7 +89,7 @@ typedef enum { ...@@ -89,7 +89,7 @@ typedef enum {
/** /**
* GtkAboutDialog: * GtkAboutDialog:
* *
* The <structname>GtkAboutDialog</structname> struct contains * The #GtkAboutDialog-struct contains
* only private fields and should not be directly accessed. * only private fields and should not be directly accessed.
*/ */
struct _GtkAboutDialog struct _GtkAboutDialog
......
...@@ -53,7 +53,7 @@ typedef struct _GtkAccelLabelPrivate GtkAccelLabelPrivate; ...@@ -53,7 +53,7 @@ typedef struct _GtkAccelLabelPrivate GtkAccelLabelPrivate;
/** /**
* GtkAccelLabel: * GtkAccelLabel:
* *
* The #GtkAccelLabel-struct struct contains private data only, and * The #GtkAccelLabel-struct contains private data only, and
* should be accessed using the functions below. * should be accessed using the functions below.
*/ */
struct _GtkAccelLabel struct _GtkAccelLabel
......
...@@ -48,7 +48,7 @@ typedef struct _GtkAdjustmentClass GtkAdjustmentClass; ...@@ -48,7 +48,7 @@ typedef struct _GtkAdjustmentClass GtkAdjustmentClass;
/** /**
* GtkAdjustment: * GtkAdjustment:
* *
* The #GtkAdjustment struct contains only private fields and * The #GtkAdjustment-struct contains only private fields and
* should not be directly accessed. * should not be directly accessed.
*/ */
struct _GtkAdjustment struct _GtkAdjustment
......
...@@ -29,9 +29,9 @@ ...@@ -29,9 +29,9 @@
/** /**
* gtk_border_new: * gtk_border_new:
* *
* Allocates a new #GtkBorder structure and initializes its elements to zero. * Allocates a new #GtkBorder-struct and initializes its elements to zero.
* *
* Returns: a newly allocated #GtkBorder. Free with gtk_border_free() * Returns: a newly allocated #GtkBorder-struct. Free with gtk_border_free()
* *
* Since: 2.14 * Since: 2.14
*/ */
...@@ -43,9 +43,9 @@ gtk_border_new (void) ...@@ -43,9 +43,9 @@ gtk_border_new (void)
/** /**
* gtk_border_copy: * gtk_border_copy:
* @border_: a #GtkBorder * @border_: a #GtkBorder-struct
* *
* Copies a #GtkBorder structure. * Copies a #GtkBorder-struct.
* *
* Returns: a copy of @border_. * Returns: a copy of @border_.
*/ */
...@@ -59,9 +59,9 @@ gtk_border_copy (const GtkBorder *border_) ...@@ -59,9 +59,9 @@ gtk_border_copy (const GtkBorder *border_)
/** /**
* gtk_border_free: * gtk_border_free:
* @border_: a #GtkBorder * @border_: a #GtkBorder-struct
* *
* Frees a #GtkBorder structure. * Frees a #GtkBorder-struct.
*/ */
void void
gtk_border_free (GtkBorder *border_) gtk_border_free (GtkBorder *border_)
......
...@@ -233,7 +233,7 @@ gtk_buildable_construct_child (GtkBuildable *buildable, ...@@ -233,7 +233,7 @@ gtk_buildable_construct_child (GtkBuildable *buildable,
* @builder: a #GtkBuilder used to construct this object * @builder: a #GtkBuilder used to construct this object
* @child: (allow-none): child object or %NULL for non-child tags * @child: (allow-none): child object or %NULL for non-child tags
* @tagname: name of tag * @tagname: name of tag
* @parser: (out): a #GMarkupParser structure to fill in * @parser: (out): a #GMarkupParser to fill in
* @data: (out): return location for user data that will be passed in * @data: (out): return location for user data that will be passed in
* to parser functions * to parser functions
* *
......
...@@ -63,7 +63,7 @@ typedef struct _GtkBuildableIface GtkBuildableIface; ...@@ -63,7 +63,7 @@ typedef struct _GtkBuildableIface GtkBuildableIface;
* constructed object is returned and becomes owned by the caller. * constructed object is returned and becomes owned by the caller.
* @custom_tag_start: Implement this if the buildable needs to parse * @custom_tag_start: Implement this if the buildable needs to parse
* content below &lt;child&gt;. To handle an element, the implementation * content below &lt;child&gt;. To handle an element, the implementation
* must fill in the @parser structure and @user_data and return %TRUE. * must fill in the @parser and @user_data and return %TRUE.
* #GtkWidget implements this to parse keyboard accelerators specified * #GtkWidget implements this to parse keyboard accelerators specified
* in &lt;accelerator&gt; elements. #GtkContainer implements it to map * in &lt;accelerator&gt; elements. #GtkContainer implements it to map
* properties defined via &lt;packing&gt; elements to child properties. * properties defined via &lt;packing&gt; elements to child properties.
...@@ -82,9 +82,9 @@ typedef struct _GtkBuildableIface GtkBuildableIface; ...@@ -82,9 +82,9 @@ typedef struct _GtkBuildableIface GtkBuildableIface;
* Implement this if the buildable has internal children that may * Implement this if the buildable has internal children that may
* need to be accessed from a UI definition. * need to be accessed from a UI definition.
* *
* The GtkBuildableIface interface contains method that are * The #GtkBuildableIface interface contains method that are
* necessary to allow #GtkBuilder to construct an object from * necessary to allow #GtkBuilder to construct an object from
* a GtkBuilder UI definition. * a #GtkBuilder UI definition.
*/ */
struct _GtkBuildableIface struct _GtkBuildableIface
{ {
......
...@@ -1586,7 +1586,7 @@ gtk_builder_connect_signals_default (GtkBuilder *builder, ...@@ -1586,7 +1586,7 @@ gtk_builder_connect_signals_default (GtkBuilder *builder,
/** /**
* gtk_builder_connect_signals: * gtk_builder_connect_signals:
* @builder: a #GtkBuilder * @builder: a #GtkBuilder
* @user_data: a pointer to a structure sent in as user data to all signals * @user_data: user data to pass back with all signals
* *
* This method is a simpler variation of gtk_builder_connect_signals_full(). * This method is a simpler variation of gtk_builder_connect_signals_full().
* It uses symbols explicitly added to @builder with prior calls to * It uses symbols explicitly added to @builder with prior calls to
......
...@@ -142,7 +142,7 @@ ...@@ -142,7 +142,7 @@
* is the id of widget (which should be a child of the dialogs @action_area). * is the id of widget (which should be a child of the dialogs @action_area).
* </para> * </para>
* <example> * <example>
* <title>A <structname>GtkDialog</structname> UI definition fragment.</title> * <title>A #GtkDialog UI definition fragment.</title>
* <programlisting><![CDATA[ * <programlisting><![CDATA[
* <object class="GtkDialog" id="dialog1"> * <object class="GtkDialog" id="dialog1">
* <child internal-child="vbox">" * <child internal-child="vbox">"
......
...@@ -103,7 +103,7 @@ typedef struct _GtkDialogClass GtkDialogClass; ...@@ -103,7 +103,7 @@ typedef struct _GtkDialogClass GtkDialogClass;
/** /**
* GtkDialog: * GtkDialog:
* *
* The GtkDialog struct contains only private fields * The #GtkDialog-struct contains only private fields
* and should not be directly accessed. * and should not be directly accessed.
*/ */
struct _GtkDialog struct _GtkDialog
......
...@@ -537,7 +537,7 @@ gtk_file_filter_add_custom (GtkFileFilter *filter, ...@@ -537,7 +537,7 @@ gtk_file_filter_add_custom (GtkFileFilter *filter,
* gtk_file_filter_get_needed: * gtk_file_filter_get_needed:
* @filter: a #GtkFileFilter * @filter: a #GtkFileFilter
* *
* Gets the fields that need to be filled in for the structure * Gets the fields that need to be filled in for the #GtkFileFilterInfo
* passed to gtk_file_filter_filter() * passed to gtk_file_filter_filter()
* *
* This function will not typically be used by applications; it * This function will not typically be used by applications; it
...@@ -558,11 +558,11 @@ gtk_file_filter_get_needed (GtkFileFilter *filter) ...@@ -558,11 +558,11 @@ gtk_file_filter_get_needed (GtkFileFilter *filter)
/** /**
* gtk_file_filter_filter: * gtk_file_filter_filter:
* @filter: a #GtkFileFilter * @filter: a #GtkFileFilter
* @filter_info: a #GtkFileFilterInfo structure containing information * @filter_info: a #GtkFileFilterInfo containing information
* about a file. * about a file.
* *
* Tests whether a file should be displayed according to @filter. * Tests whether a file should be displayed according to @filter.
* The #GtkFileFilterInfo structure @filter_info should include * The #GtkFileFilterInfo @filter_info should include
* the fields returned from gtk_file_filter_get_needed(). * the fields returned from gtk_file_filter_get_needed().
* *
* This function will not typically be used by applications; it * This function will not typically be used by applications; it
......
...@@ -77,7 +77,7 @@ typedef gboolean (*GtkFileFilterFunc) (const GtkFileFilterInfo *filter_info, ...@@ -77,7 +77,7 @@ typedef gboolean (*GtkFileFilterFunc) (const GtkFileFilterInfo *filter_info,
* in the file chooser * in the file chooser
* @mime_type: the mime type of the file * @mime_type: the mime type of the file
* *
* A #GtkFileFilterInfo struct is used to pass information about the * A #GtkFileFilterInfo-struct is used to pass information about the
* tested file to gtk_file_filter_filter(). * tested file to gtk_file_filter_filter().
*/ */
struct _GtkFileFilterInfo struct _GtkFileFilterInfo
......
...@@ -1646,13 +1646,13 @@ _gtk_file_system_model_iter_is_filtered_out (GtkFileSystemModel *model, ...@@ -1646,13 +1646,13 @@ _gtk_file_system_model_iter_is_filtered_out (GtkFileSystemModel *model,
* @model: a #GtkFileSystemModel * @model: a #GtkFileSystemModel
* @iter: a #GtkTreeIter pointing to a row of @model * @iter: a #GtkTreeIter pointing to a row of @model
* *
* Gets the #GFileInfo structure for a particular row * Gets the #GFileInfo-struct for a particular row
* of @model. * of @model.
* *
* Return value: a #GFileInfo structure. This structure * Return value: a #GFileInfo-struct. This value
* is owned by @model and must not be modified or freed. * is owned by @model and must not be modified or freed.
* If you want to keep the information for later use, * If you want to keep the information for later use,
* you must take a reference, since the structure may be * you must take a reference, since the #GFileInfo-struct may be
* freed on later changes to the file system. If you have * freed on later changes to the file system. If you have
* called _gtk_file_system_model_add_editable() and the @iter * called _gtk_file_system_model_add_editable() and the @iter
* corresponds to the row that this function returned, the * corresponds to the row that this function returned, the
......
...@@ -1805,7 +1805,7 @@ choose_icon (GtkIconTheme *icon_theme, ...@@ -1805,7 +1805,7 @@ choose_icon (GtkIconTheme *icon_theme,
* @size: desired icon size * @size: desired icon size
* @flags: flags modifying the behavior of the icon lookup * @flags: flags modifying the behavior of the icon lookup
* *
* Looks up a named icon and returns a structure containing * Looks up a named icon and returns a #GtkIconInfo containing
* information such as the filename of the icon. The icon * information such as the filename of the icon. The icon
* can then be rendered into a pixbuf using * can then be rendered into a pixbuf using
* gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
...@@ -1843,7 +1843,7 @@ gtk_icon_theme_lookup_icon (GtkIconTheme *icon_theme, ...@@ -1843,7 +1843,7 @@ gtk_icon_theme_lookup_icon (GtkIconTheme *icon_theme,
* @flags: flags modifying the behavior of the icon lookup * @flags: flags modifying the behavior of the icon lookup
* *
* Looks up a named icon for a particular window scale and returns a * Looks up a named icon for a particular window scale and returns a
* structure containing information such as the filename of the * #GtkIconInfo containing information such as the filename of the
* icon. The icon can then be rendered into a pixbuf using * icon. The icon can then be rendered into a pixbuf using
* gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() combines * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() combines
* these two steps if all you need is the pixbuf.) * these two steps if all you need is the pixbuf.)
...@@ -1942,7 +1942,7 @@ gtk_icon_theme_lookup_icon_for_scale (GtkIconTheme *icon_theme, ...@@ -1942,7 +1942,7 @@ gtk_icon_theme_lookup_icon_for_scale (GtkIconTheme *icon_theme,
* @size: desired icon size * @size: desired icon size
* @flags: flags modifying the behavior of the icon lookup * @flags: flags modifying the behavior of the icon lookup
* *
* Looks up a named icon and returns a structure containing * Looks up a named icon and returns a #GtkIconInfo containing
* information such as the filename of the icon. The icon * information such as the filename of the icon. The icon
* can then be rendered into a pixbuf using * can then be rendered into a pixbuf using
* gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
...@@ -1981,7 +1981,7 @@ gtk_icon_theme_choose_icon (GtkIconTheme *icon_theme, ...@@ -1981,7 +1981,7 @@ gtk_icon_theme_choose_icon (GtkIconTheme *icon_theme,
* @flags: flags modifying the behavior of the icon lookup * @flags: flags modifying the behavior of the icon lookup
* *
* Looks up a named icon for a particular window scale and returns a * Looks up a named icon for a particular window scale and returns a
* structure containing information such as the filename of the * #GtkIconInfo containing information such as the filename of the
* icon. The icon can then be rendered into a pixbuf using * icon. The icon can then be rendered into a pixbuf using
* gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() combines * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() combines
* these two steps if all you need is the pixbuf.) * these two steps if all you need is the pixbuf.)
...@@ -3519,7 +3519,7 @@ gtk_icon_info_get_filename (GtkIconInfo *icon_info) ...@@ -3519,7 +3519,7 @@ gtk_icon_info_get_filename (GtkIconInfo *icon_info)
/** /**
* gtk_icon_info_get_builtin_pixbuf: * gtk_icon_info_get_builtin_pixbuf:
* @icon_info: a #GtkIconInfo structure * @icon_info: a #GtkIconInfo
* *
* Gets the built-in image for this icon, if any. To allow * Gets the built-in image for this icon, if any. To allow
* GTK+ to use built in icon images, you must pass the * GTK+ to use built in icon images, you must pass the
...@@ -3546,7 +3546,7 @@ gtk_icon_info_get_builtin_pixbuf (GtkIconInfo *icon_info) ...@@ -3546,7 +3546,7 @@ gtk_icon_info_get_builtin_pixbuf (GtkIconInfo *icon_info)
/** /**
* gtk_icon_info_is_symbolic: * gtk_icon_info_is_symbolic:
* @icon_info: a #GtkIconInfo structure * @icon_info: a #GtkIconInfo
* *
* Checks if the icon is symbolic or not. This currently uses only * Checks if the icon is symbolic or not. This currently uses only
* the file name and not the file contents for determining this. * the file name and not the file contents for determining this.
...@@ -3878,7 +3878,7 @@ proxy_pixbuf_destroy (guchar *pixels, gpointer data) ...@@ -3878,7 +3878,7 @@ proxy_pixbuf_destroy (guchar *pixels, gpointer data)
/** /**
* gtk_icon_info_load_icon: * gtk_icon_info_load_icon:
* @icon_info: a #GtkIconInfo structure from gtk_icon_theme_lookup_icon() * @icon_info: a #GtkIconInfo from gtk_icon_theme_lookup_icon()
* @error: (allow-none): location to store error information on failure, * @error: (allow-none): location to store error information on failure,
* or %NULL. * or %NULL.
* *
...@@ -3952,7 +3952,7 @@ gtk_icon_info_load_icon (GtkIconInfo *icon_info, ...@@ -3952,7 +3952,7 @@ gtk_icon_info_load_icon (GtkIconInfo *icon_info,
/** /**
* gtk_icon_info_load_surface: * gtk_icon_info_load_surface:
* @icon_info: a #GtkIconInfo structure from gtk_icon_theme_lookup_icon() * @icon_info: a #GtkIconInfo from gtk_icon_theme_lookup_icon()
* @for_window: (allow-none): #GdkWindow to optimize drawing for, or %NULL * @for_window: (allow-none): #GdkWindow to optimize drawing for, or %NULL
* @error: (allow-none): location to store error information on failure, * @error: (allow-none): location to store error information on failure,
* or %NULL. * or %NULL.
...@@ -4012,7 +4012,7 @@ load_icon_thread (GTask *task, ...@@ -4012,7 +4012,7 @@ load_icon_thread (GTask *task,
/** /**
* gtk_icon_info_load_icon_async: * gtk_icon_info_load_icon_async:
* @icon_info: a #GtkIconInfo structure from gtk_icon_theme_lookup_icon() * @icon_info: a #GtkIconInfo from gtk_icon_theme_lookup_icon()
* @cancellable: (allow-none): optional #GCancellable object, * @cancellable: (allow-none): optional #GCancellable object,
* %NULL to ignore * %NULL to ignore
* @callback: (scope async): a #GAsyncReadyCallback to call when the * @callback: (scope async): a #GAsyncReadyCallback to call when the
...@@ -4060,7 +4060,7 @@ gtk_icon_info_load_icon_async (GtkIconInfo *icon_info, ...@@ -4060,7 +4060,7 @@ gtk_icon_info_load_icon_async (GtkIconInfo *icon_info,
/** /**
* gtk_icon_info_load_icon_finish: * gtk_icon_info_load_icon_finish:
* @icon_info: a #GtkIconInfo structure from gtk_icon_theme_lookup_icon() * @icon_info: a #GtkIconInfo from gtk_icon_theme_lookup_icon()
* @res: a #GAsyncResult * @res: a #GAsyncResult
* @error: (allow-none): location to store error information on failure, * @error: (allow-none): location to store error information on failure,
* or %NULL. * or %NULL.
...@@ -4526,7 +4526,7 @@ load_symbolic_icon_thread (GTask *task, ...@@ -4526,7 +4526,7 @@ load_symbolic_icon_thread (GTask *task,
/** /**
* gtk_icon_info_load_symbolic_async: * gtk_icon_info_load_symbolic_async:
* @icon_info: a #GtkIconInfo structure from gtk_icon_theme_lookup_icon() * @icon_info: a #GtkIconInfo from gtk_icon_theme_lookup_icon()
* @fg: a #GdkRGBA representing the foreground color of the icon * @fg: a #GdkRGBA representing the foreground color of the icon
* @success_color: (allow-none): a #GdkRGBA representing the warning color * @success_color: (allow-none): a #GdkRGBA representing the warning color
* of the icon or %NULL to use the default color * of the icon or %NULL to use the default color
...@@ -4621,7 +4621,7 @@ gtk_icon_info_load_symbolic_async (GtkIconInfo *icon_info, ...@@ -4621,7 +4621,7 @@ gtk_icon_info_load_symbolic_async (GtkIconInfo *icon_info,
/** /**
* gtk_icon_info_load_symbolic_finish: * gtk_icon_info_load_symbolic_finish:
* @icon_info: a #GtkIconInfo structure from gtk_icon_theme_lookup_icon() * @icon_info: a #GtkIconInfo from gtk_icon_theme_lookup_icon()
* @res: a #GAsyncResult * @res: a #GAsyncResult
* @was_symbolic: (out) (allow-none): a #gboolean, returns whether the * @was_symbolic: (out) (allow-none): a #gboolean, returns whether the
* loaded icon was a symbolic one and whether the @fg color was * loaded icon was a symbolic one and whether the @fg color was
...@@ -4685,7 +4685,7 @@ gtk_icon_info_load_symbolic_finish (GtkIconInfo *icon_info, ...@@ -4685,7 +4685,7 @@ gtk_icon_info_load_symbolic_finish (GtkIconInfo *icon_info,
/** /**
* gtk_icon_info_load_symbolic_for_context_async: * gtk_icon_info_load_symbolic_for_context_async:
* @icon_info: a #GtkIconInfo structure from gtk_icon_theme_lookup_icon() * @icon_info: a #GtkIconInfo from gtk_icon_theme_lookup_icon()
* @context: a #GtkStyleContext * @context: a #GtkStyleContext
* @cancellable: (allow-none): optional #GCancellable object, * @cancellable: (allow-none): optional #GCancellable object,
* %NULL to ignore * %NULL to ignore
...@@ -4750,7 +4750,7 @@ gtk_icon_info_load_symbolic_for_context_async (GtkIconInfo *icon_info, ...@@ -4750,7 +4750,7 @@ gtk_icon_info_load_symbolic_for_context_async (GtkIconInfo *icon_info,
/** /**
* gtk_icon_info_load_symbolic_for_context_finish: * gtk_icon_info_load_symbolic_for_context_finish:
* @icon_info: a #GtkIconInfo structure from gtk_icon_theme_lookup_icon() * @icon_info: a #GtkIconInfo from gtk_icon_theme_lookup_icon()
* @res: a #GAsyncResult * @res: a #GAsyncResult
* @was_symbolic: (out) (allow-none): a #gboolean, returns whether the * @was_symbolic: (out) (allow-none): a #gboolean, returns whether the
* loaded icon was a symbolic one and whether the @fg color was * loaded icon was a symbolic one and whether the @fg color was
...@@ -5189,12 +5189,12 @@ find_builtin_icon (const gchar *icon_name, ...@@ -5189,12 +5189,12 @@ find_builtin_icon (const gchar *icon_name,
* @size: desired icon size * @size: desired icon size
* @flags: flags modifying the behavior of the icon lookup * @flags: flags modifying the behavior of the icon lookup