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

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

parent 8418e642
......@@ -47,7 +47,7 @@
* gdk_color_copy:
* @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().
*
......@@ -69,7 +69,7 @@ gdk_color_copy (const GdkColor *color)
* gdk_color_free:
* @color: a #GdkColor
*
* Frees a color structure created with gdk_color_copy().
* Frees a #GdkColor created with gdk_color_copy().
*/
void
gdk_color_free (GdkColor *color)
......@@ -129,8 +129,7 @@ G_DEFINE_BOXED_TYPE (GdkColor, gdk_color,
*
* Parses a textual specification of a color and fill in the
* <structfield>red</structfield>, <structfield>green</structfield>,
* and <structfield>blue</structfield> fields of a #GdkColor
* structure.
* and <structfield>blue</structfield> fields of a #GdkColor.
*
* The string can either one of a large set of standard names
* (taken from the X11 <filename>rgb.txt</filename> file), or
......
......@@ -46,7 +46,7 @@ G_BEGIN_DECLS
* @green: The green 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.
*/
struct _GdkColor
......
......@@ -54,13 +54,13 @@
* Cursors by themselves are not very interesting, they must be be
* 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
* #GdkWindowAttr struct passed to gdk_window_new().
* #GdkWindowAttr passed to gdk_window_new().
*/
/**
* GdkCursor:
*
* The #GdkCursor structure represents a cursor. Its contents are private.
* A #GdkCursor represents a cursor. Its contents are private.
*/
enum {
......
......@@ -134,7 +134,7 @@ typedef enum {
* @time: The timestamp for this event.
* @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
{
......
......@@ -43,7 +43,7 @@ G_BEGIN_DECLS
* @Short_description: Data structures specific to each type of event
* @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>
* <para>
......@@ -1154,10 +1154,10 @@ struct _GdkEventDND {
* @setting: a #GdkEventSetting
* @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.
*
* 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
* event it is:
* <informalexample>
......@@ -1169,8 +1169,8 @@ struct _GdkEventDND {
* </programlisting>
* </informalexample>
*
* To access other fields of the event structs, the pointer to the event
* can be cast to the appropriate event struct pointer, or the union member
* To access other fields of the event, the pointer to the event
* 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
* then the x coordinate of the button press can be accessed with:
* <informalexample>
......
......@@ -36,9 +36,9 @@
* 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.
*
* #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
* gdk_rectangle_intersect(). To find the union of two rectangles use
* gdk_rectangle_union().
......
......@@ -35,7 +35,7 @@
* @Short_description: 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.
* 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
......@@ -54,7 +54,7 @@ G_DEFINE_BOXED_TYPE (GdkRGBA, gdk_rgba,
* @alpha: The opacity of the color from 0.0 for completely translucent to
* 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.
*/
......@@ -62,7 +62,7 @@ G_DEFINE_BOXED_TYPE (GdkRGBA, gdk_rgba,
* gdk_rgba_copy:
* @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().
*
......@@ -80,7 +80,7 @@ gdk_rgba_copy (const GdkRGBA *rgba)
* gdk_rgba_free:
* @rgba: a #GdkRGBA
*
* Frees a #GdkRGBA struct created with gdk_rgba_copy()
* Frees a #GdkRGBA created with gdk_rgba_copy()
*
* Since: 3.0
*/
......@@ -134,13 +134,13 @@ parse_rgb_value (const gchar *str,
/**
* gdk_rgba_parse:
* @rgba: the #GdkRGBA struct to fill in
* @rgba: the #GdkRGBA to fill in
* @spec: the string specifying the color
*
* Parses a textual representation of a color, filling in
* the <structfield>red</structfield>, <structfield>green</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:
* <itemizedlist>
......
......@@ -75,7 +75,7 @@ typedef enum
/**
* GdkVisual:
*
* The #GdkVisual structure contains information about
* A #GdkVisual contains information about
* a particular visual.
*/
......
......@@ -1815,7 +1815,7 @@ gtk_rc_parse_priority (GScanner *scanner,
/**
* gtk_rc_parse_color:
* @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
*
* Parses a color in the format expected
......@@ -1840,7 +1840,7 @@ gtk_rc_parse_color (GScanner *scanner,
* gtk_rc_parse_color_full:
* @scanner: a #GScanner
* @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
*
* Parses a color in the format expected
......
......@@ -74,10 +74,10 @@ typedef enum
* @xthickness: X 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.
* This can later be composited together with other
* #GtkRcStyle structures to form a #GtkStyle.
* #GtkRcStyle-struct<!-- -->s to form a #GtkStyle.
*/
struct _GtkRcStyle
{
......
......@@ -4187,14 +4187,14 @@ gtk_widget_get_style (GtkWidget *widget)
/**
* gtk_widget_modify_style:
* @widget: a #GtkWidget
* @style: the #GtkRcStyle holding the style modifications
* @style: the #GtkRcStyle-struct holding the style modifications
*
* Modifies style values on the widget.
*
* Modifications made using this technique take precedence over
* 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().
* 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
* style values and leave the others unchanged.
*
......
......@@ -89,7 +89,7 @@ typedef enum {
/**
* GtkAboutDialog:
*
* The <structname>GtkAboutDialog</structname> struct contains
* The #GtkAboutDialog-struct contains
* only private fields and should not be directly accessed.
*/
struct _GtkAboutDialog
......
......@@ -53,7 +53,7 @@ typedef struct _GtkAccelLabelPrivate GtkAccelLabelPrivate;
/**
* 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.
*/
struct _GtkAccelLabel
......
......@@ -48,7 +48,7 @@ typedef struct _GtkAdjustmentClass GtkAdjustmentClass;
/**
* GtkAdjustment:
*
* The #GtkAdjustment struct contains only private fields and
* The #GtkAdjustment-struct contains only private fields and
* should not be directly accessed.
*/
struct _GtkAdjustment
......
......@@ -29,9 +29,9 @@
/**
* 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
*/
......@@ -43,9 +43,9 @@ gtk_border_new (void)
/**
* gtk_border_copy:
* @border_: a #GtkBorder
* @border_: a #GtkBorder-struct
*
* Copies a #GtkBorder structure.
* Copies a #GtkBorder-struct.
*
* Returns: a copy of @border_.
*/
......@@ -59,9 +59,9 @@ gtk_border_copy (const GtkBorder *border_)
/**
* gtk_border_free:
* @border_: a #GtkBorder
* @border_: a #GtkBorder-struct
*
* Frees a #GtkBorder structure.
* Frees a #GtkBorder-struct.
*/
void
gtk_border_free (GtkBorder *border_)
......
......@@ -233,7 +233,7 @@ gtk_buildable_construct_child (GtkBuildable *buildable,
* @builder: a #GtkBuilder used to construct this object
* @child: (allow-none): child object or %NULL for non-child tags
* @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
* to parser functions
*
......
......@@ -63,7 +63,7 @@ typedef struct _GtkBuildableIface GtkBuildableIface;
* constructed object is returned and becomes owned by the caller.
* @custom_tag_start: Implement this if the buildable needs to parse
* 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
* in &lt;accelerator&gt; elements. #GtkContainer implements it to map
* properties defined via &lt;packing&gt; elements to child properties.
......@@ -82,9 +82,9 @@ typedef struct _GtkBuildableIface GtkBuildableIface;
* Implement this if the buildable has internal children that may
* 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
* a GtkBuilder UI definition.
* a #GtkBuilder UI definition.
*/
struct _GtkBuildableIface
{
......
......@@ -1586,7 +1586,7 @@ gtk_builder_connect_signals_default (GtkBuilder *builder,
/**
* gtk_builder_connect_signals:
* @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().
* It uses symbols explicitly added to @builder with prior calls to
......
......@@ -142,7 +142,7 @@
* is the id of widget (which should be a child of the dialogs @action_area).
* </para>
* <example>
* <title>A <structname>GtkDialog</structname> UI definition fragment.</title>
* <title>A #GtkDialog UI definition fragment.</title>
* <programlisting><![CDATA[
* <object class="GtkDialog" id="dialog1">
* <child internal-child="vbox">"
......
......@@ -103,7 +103,7 @@ typedef struct _GtkDialogClass GtkDialogClass;
/**
* GtkDialog:
*
* The GtkDialog struct contains only private fields
* The #GtkDialog-struct contains only private fields
* and should not be directly accessed.
*/
struct _GtkDialog
......
Supports Markdown
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