summaryrefslogtreecommitdiff
path: root/gtk
diff options
context:
space:
mode:
authorHavoc Pennington <hp@pobox.com>2001-09-08 06:24:46 +0000
committerHavoc Pennington <hp@src.gnome.org>2001-09-08 06:24:46 +0000
commit372853b107d752cdb5e8d180be9b6a1c9a752f36 (patch)
tree69d17ae59b862b94edee72928f83ea925168035b /gtk
parentf6d7585d006aad0dcba05bc4e55ea38608a53496 (diff)
downloadgdk-pixbuf-372853b107d752cdb5e8d180be9b6a1c9a752f36.tar.gz
put GtkPacker back in here so it won't be in gtk-unused.txt, but don't put
2001-09-08 Havoc Pennington <hp@pobox.com> * gtk/gtk-sections.txt: put GtkPacker back in here so it won't be in gtk-unused.txt, but don't put it back in gtk-docs.sgml. Tons of other additions from gtk-unused.txt, but mostly skipping all the tree stuff for now. 2001-09-08 Havoc Pennington <hp@pobox.com> * gtk/gtktreeviewcolumn.c (gtk_tree_view_column_add_attribute): docs fixes * gtk/gtktable.c (gtk_table_get_col_spacing): docs fixes * gtk/gtkspinbutton.c (gtk_spin_button_get_increments): docs fixes * gtk/gtksocket.c (gtk_socket_steal): docs fixes * gtk/gtkscrolledwindow.h: docs fixes * gtk/gtkimage.c (gtk_image_new): docs fixes
Diffstat (limited to 'gtk')
-rw-r--r--gtk/gtkimage.c1
-rw-r--r--gtk/gtkrc.c17
-rw-r--r--gtk/gtkscrolledwindow.h2
-rw-r--r--gtk/gtksocket.c7
-rw-r--r--gtk/gtkspinbutton.c2
-rw-r--r--gtk/gtktable.c2
-rw-r--r--gtk/gtktreeviewcolumn.c20
-rw-r--r--gtk/gtkwindow.c16
-rw-r--r--gtk/gtkwindow.h4
9 files changed, 37 insertions, 34 deletions
diff --git a/gtk/gtkimage.c b/gtk/gtkimage.c
index bef35eccb..7c8bebc5b 100644
--- a/gtk/gtkimage.c
+++ b/gtk/gtkimage.c
@@ -1104,7 +1104,6 @@ gtk_image_get_animation (GtkImage *image)
/**
* gtk_image_new:
- * @void: a #GtkImage
*
* Creates a new empty #GtkImage widget.
*
diff --git a/gtk/gtkrc.c b/gtk/gtkrc.c
index eaed57f15..70c3fd019 100644
--- a/gtk/gtkrc.c
+++ b/gtk/gtkrc.c
@@ -492,13 +492,13 @@ gtk_rc_add_initial_default_files (void)
/**
* gtk_rc_add_default_file:
- * @file: the pathname to the file.
+ * @filename: the pathname to the file.
*
* Adds a file to the list of files to be parsed at the
* end of gtk_init().
**/
void
-gtk_rc_add_default_file (const gchar *file)
+gtk_rc_add_default_file (const gchar *filename)
{
guint n;
@@ -508,19 +508,19 @@ gtk_rc_add_default_file (const gchar *file)
if (n >= GTK_RC_MAX_DEFAULT_FILES - 1)
return;
- gtk_rc_default_files[n++] = g_strdup (file);
+ gtk_rc_default_files[n++] = g_strdup (filename);
gtk_rc_default_files[n] = NULL;
}
/**
* gtk_rc_set_default_files:
- * @files: A %NULL terminated list of filenames.
+ * @filenames: A %NULL terminated list of filenames.
*
* Sets the list of files that GTK+ will read at the
* end of gtk_init()
**/
void
-gtk_rc_set_default_files (gchar **files)
+gtk_rc_set_default_files (gchar **filenames)
{
gint i;
@@ -536,16 +536,15 @@ gtk_rc_set_default_files (gchar **files)
gtk_rc_default_files[0] = NULL;
i = 0;
- while (files[i] != NULL)
+ while (filenames[i] != NULL)
{
- gtk_rc_add_default_file (files[i]);
+ gtk_rc_add_default_file (filenames[i]);
i++;
}
}
/**
* gtk_rc_get_default_files:
- * @void:
*
* Retrieves the current list of RC files that will be parsed
* at the end of gtk_init()
@@ -1454,7 +1453,7 @@ gtk_rc_styles_match (GSList *rc_styles,
* created styles, so a new style may not be
* created.)
*
- * @Returns: the resulting style. No refcount is added
+ * Returns: the resulting style. No refcount is added
* to the returned style, so if you want to save this
* style around, you should add a reference yourself.
**/
diff --git a/gtk/gtkscrolledwindow.h b/gtk/gtkscrolledwindow.h
index afae4414a..d8dedd9be 100644
--- a/gtk/gtkscrolledwindow.h
+++ b/gtk/gtkscrolledwindow.h
@@ -89,7 +89,7 @@ void gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolle
GtkPolicyType vscrollbar_policy);
void gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window,
GtkPolicyType *hscrollbar_policy,
- GtkPolicyType *vscrollvar_policy);
+ GtkPolicyType *vscrollbar_policy);
void gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window,
GtkCornerType window_placement);
GtkCornerType gtk_scrolled_window_get_placement (GtkScrolledWindow *scrolled_window);
diff --git a/gtk/gtksocket.c b/gtk/gtksocket.c
index a1ff7226b..12356b5d3 100644
--- a/gtk/gtksocket.c
+++ b/gtk/gtksocket.c
@@ -189,7 +189,6 @@ gtk_socket_init (GtkSocket *socket)
/**
* gtk_socket_new:
- * @void:
*
* Create a new empty #GtkSocket.
*
@@ -208,7 +207,7 @@ gtk_socket_new (void)
/**
* gtk_socket_steal:
* @socket: a #GtkSocket
- * @id: the XID of an existing toplevel window.
+ * @wid: the XID of an existing toplevel window.
*
* Reparents a pre-existing toplevel window into a #GtkSocket. This is
* meant to embed clients that do not know about embedding into a
@@ -219,7 +218,7 @@ gtk_socket_new (void)
* before you can make this call.
**/
void
-gtk_socket_steal (GtkSocket *socket, GdkNativeWindow id)
+gtk_socket_steal (GtkSocket *socket, GdkNativeWindow wid)
{
g_return_if_fail (GTK_IS_SOCKET (socket));
g_return_if_fail (GTK_WIDGET_ANCHORED (socket));
@@ -227,7 +226,7 @@ gtk_socket_steal (GtkSocket *socket, GdkNativeWindow id)
if (!GTK_WIDGET_REALIZED (socket))
gtk_widget_realize (GTK_WIDGET (socket));
- gtk_socket_add_window (socket, id, TRUE);
+ gtk_socket_add_window (socket, wid, TRUE);
}
/**
diff --git a/gtk/gtkspinbutton.c b/gtk/gtkspinbutton.c
index fac28a46a..acb463f9f 100644
--- a/gtk/gtkspinbutton.c
+++ b/gtk/gtkspinbutton.c
@@ -1682,7 +1682,7 @@ gtk_spin_button_set_increments (GtkSpinButton *spin_button,
/**
* gtk_spin_button_get_increments:
- * @psin_button: a #GtkSpinButton
+ * @spin_button: a #GtkSpinButton
* @step: location to store step increment, or %NULL
* @page: location to store page increment, or %NULL
*
diff --git a/gtk/gtktable.c b/gtk/gtktable.c
index f1696a7fa..32f7d51ca 100644
--- a/gtk/gtktable.c
+++ b/gtk/gtktable.c
@@ -685,7 +685,7 @@ gtk_table_set_col_spacing (GtkTable *table,
/**
* gtk_table_get_col_spacing:
* @table: a #GtkTable
- * @col: a column in the table, 0 indicates the first column
+ * @column: a column in the table, 0 indicates the first column
*
* Gets the amount of space between column @col, and
* column @col + 1. See gtk_table_set_col_spacing().
diff --git a/gtk/gtktreeviewcolumn.c b/gtk/gtktreeviewcolumn.c
index c7bbeb2ce..c1dac7c48 100644
--- a/gtk/gtktreeviewcolumn.c
+++ b/gtk/gtktreeviewcolumn.c
@@ -1180,12 +1180,16 @@ gtk_tree_view_column_get_cell_renderers (GtkTreeViewColumn *tree_column)
/**
* gtk_tree_view_column_add_attribute:
* @tree_column: A #GtkTreeViewColumn.
- * @attribute: An attribute on the columns cell
+ * @cell_renderer: the #GtkCellRenderer to set attributes on
+ * @attribute: An attribute on the renderer
* @column: The column position on the model to get the attribute from.
*
* Adds an attribute mapping to the list in @tree_column. The @column is the
- * column position on the model to get a value from, and the @attribute is the
- * parameter on the @tree_column's cell renderer to set that value to.
+ * column of the model to get a value from, and the @attribute is the
+ * parameter on @cell_renderer to be set from the value. So for example
+ * if column 2 of the model contains strings, you could have the
+ * "text" attribute of a #GtkCellRendererText get its values from
+ * column 2.
**/
void
gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
@@ -1230,6 +1234,7 @@ gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
/**
* gtk_tree_view_column_set_attributes:
* @tree_column: A #GtkTreeViewColumn.
+ * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
* @Varargs: A NULL terminated listing of attributes.
*
* Sets the attributes in the list as the attributes of @tree_column.
@@ -1261,10 +1266,11 @@ gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
* @func_data: The user data for @func.
* @destroy: The destroy notification for @func_data
*
- * Sets the #GtkTreeViewColumnFunc to use for the column. This function is used
- * instead of the standard attributes mapping for setting the column value, and
- * should set the value of @tree_column 's cell renderer as appropriate. @func
- * may be NULL to remove an older one.
+ * Sets the #GtkTreeViewColumnFunc to use for the column. This
+ * function is used instead of the standard attributes mapping for
+ * setting the column value, and should set the value of @tree_column's
+ * cell renderer as appropriate. @func may be NULL to remove an
+ * older one.
**/
void
gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c
index 0b51d273b..3b9c68dc0 100644
--- a/gtk/gtkwindow.c
+++ b/gtk/gtkwindow.c
@@ -2375,7 +2375,7 @@ gtk_window_resize (GtkWindow *window,
* @height: return location for height, or %NULL
*
* Obtains the current size of @window. If @window is not onscreen,
- * returns the size GTK+ will suggest to the window manager for the
+ * it returns the size GTK+ will suggest to the window manager for the
* initial window size (but this is not reliably the same as the size
* the window manager will actually select). The size obtained by
* gtk_window_get_size() is the last size received in a
@@ -2387,19 +2387,19 @@ gtk_window_resize (GtkWindow *window,
* notification that the size has changed via a configure event, and
* the size of the window gets updated.
*
- * Note #1: Nearly any use of this function creates a race condition,
+ * Note 1: Nearly any use of this function creates a race condition,
* because the size of the window may change between the time that you
* get the size and the time that you perform some action assuming
* that size is the current size. To avoid race conditions, connect to
* "configure_event" on the window and adjust your size-dependent
* state to match the size delivered in the #GdkEventConfigure.
*
- * Note #2: The returned size does NOT include the size of the window
+ * Note 2: The returned size does NOT include the size of the window
* manager decorations (aka the window frame or border). Those
* are not drawn by GTK+ and GTK+ has no reliable method of
* determining their size.
*
- * Note #3: If you are getting a window size in order to position
+ * Note 3: If you are getting a window size in order to position
* the window onscreen, there may be a better way. The preferred
* way is to simply set the window's semantic type with
* gtk_window_set_type_hint(), which allows the window manager to
@@ -2574,9 +2574,9 @@ gtk_window_move (GtkWindow *window,
*
* If you haven't changed the window gravity, its gravity will be
* #GDK_GRAVITY_NORTH_WEST. This means that gtk_window_get_position()
- * returns the position of the top-left corner of the window
- * manager frame for the window. gtk_window_move() sets the
- * position of this same top-left corner.
+ * gets the position of the top-left corner of the window manager
+ * frame for the window. gtk_window_move() sets the position of this
+ * same top-left corner.
*
* gtk_window_get_position() is not 100% reliable because the X Window System
* does not specify a way to obtain the geometry of the
@@ -4533,7 +4533,7 @@ gtk_window_set_has_frame (GtkWindow *window,
* gtk_window_get_has_frame:
* @window: a #GtkWindow
*
- * Returns whether the window has a frame window exterior to
+ * Accessor for whether the window has a frame window exterior to
* widget->window. See gtk_window_set_has_frame ().
*
* Return value: %TRUE if a frame has been added to the window
diff --git a/gtk/gtkwindow.h b/gtk/gtkwindow.h
index 32ce21d33..c34b29797 100644
--- a/gtk/gtkwindow.h
+++ b/gtk/gtkwindow.h
@@ -282,8 +282,8 @@ void gtk_window_move (GtkWindow *window,
gint x,
gint y);
void gtk_window_get_position (GtkWindow *window,
- gint *x,
- gint *y);
+ gint *root_x,
+ gint *root_y);
gboolean gtk_window_parse_geometry (GtkWindow *window,
const gchar *geometry);