summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2002-10-11 20:36:21 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2002-10-11 20:36:21 +0000
commita9b71314ee7e770bd1f9b00c14212190f3ac1427 (patch)
tree89a453049dfe787de48e30f442c858ecc48132e3
parent5591c434f876b7a0f3c62dec145a118671a32977 (diff)
downloadgtk+-a9b71314ee7e770bd1f9b00c14212190f3ac1427.tar.gz
Lots of trivial doc fixes.
-rw-r--r--ChangeLog11
-rw-r--r--ChangeLog.pre-2-1011
-rw-r--r--ChangeLog.pre-2-211
-rw-r--r--ChangeLog.pre-2-411
-rw-r--r--ChangeLog.pre-2-611
-rw-r--r--ChangeLog.pre-2-811
-rw-r--r--docs/reference/ChangeLog11
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/refcounting.sgml45
-rw-r--r--docs/reference/gtk/tmpl/gtkfilesel.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtkimage.sgml4
-rw-r--r--docs/reference/gtk/tmpl/gtkimagemenuitem.sgml8
-rw-r--r--docs/reference/gtk/tmpl/gtkrc.sgml6
-rwxr-xr-xdocs/tutorial/gtk-tut.sgml5
-rw-r--r--examples/gtkdial/gtkdial.c7
-rw-r--r--gdk/x11/gdkwindow-x11.c2
-rw-r--r--gtk/gtkimagemenuitem.c10
-rw-r--r--gtk/gtkmenuitem.c3
17 files changed, 121 insertions, 48 deletions
diff --git a/ChangeLog b/ChangeLog
index 78d4c46d95..1995b1bee6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,16 @@
2002-10-11 Matthias Clasen <maclas@gmx.de>
+ * examples/gtkdial/gtkdial.c (gtk_dial_destroy):
+ * docs/tutorial/gtk-tut.sgml: Prevent segfault from double destroy.
+
+ * gdk/x11/gdkwindow-x11.c (gdk_window_new): Typo fix.
+
+ * gtk/gtkimagemenuitem.c (gtk_image_menu_item_new_from_stock):
+ Clarify the docs.
+
+ * gtk/gtkmenuitem.c (gtk_menu_item_set_accel_path): Mention
+ gtk_menu_set_accel_group in the docs.
+
* gdk/x11/gdkwindow-x11.c (gdk_window_set_skip_pager_hint):
* gdk/gdkdisplay.c (gdk_display_set_pointer_hooks): Fix
doc comments.
diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 78d4c46d95..1995b1bee6 100644
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,5 +1,16 @@
2002-10-11 Matthias Clasen <maclas@gmx.de>
+ * examples/gtkdial/gtkdial.c (gtk_dial_destroy):
+ * docs/tutorial/gtk-tut.sgml: Prevent segfault from double destroy.
+
+ * gdk/x11/gdkwindow-x11.c (gdk_window_new): Typo fix.
+
+ * gtk/gtkimagemenuitem.c (gtk_image_menu_item_new_from_stock):
+ Clarify the docs.
+
+ * gtk/gtkmenuitem.c (gtk_menu_item_set_accel_path): Mention
+ gtk_menu_set_accel_group in the docs.
+
* gdk/x11/gdkwindow-x11.c (gdk_window_set_skip_pager_hint):
* gdk/gdkdisplay.c (gdk_display_set_pointer_hooks): Fix
doc comments.
diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2
index 78d4c46d95..1995b1bee6 100644
--- a/ChangeLog.pre-2-2
+++ b/ChangeLog.pre-2-2
@@ -1,5 +1,16 @@
2002-10-11 Matthias Clasen <maclas@gmx.de>
+ * examples/gtkdial/gtkdial.c (gtk_dial_destroy):
+ * docs/tutorial/gtk-tut.sgml: Prevent segfault from double destroy.
+
+ * gdk/x11/gdkwindow-x11.c (gdk_window_new): Typo fix.
+
+ * gtk/gtkimagemenuitem.c (gtk_image_menu_item_new_from_stock):
+ Clarify the docs.
+
+ * gtk/gtkmenuitem.c (gtk_menu_item_set_accel_path): Mention
+ gtk_menu_set_accel_group in the docs.
+
* gdk/x11/gdkwindow-x11.c (gdk_window_set_skip_pager_hint):
* gdk/gdkdisplay.c (gdk_display_set_pointer_hooks): Fix
doc comments.
diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4
index 78d4c46d95..1995b1bee6 100644
--- a/ChangeLog.pre-2-4
+++ b/ChangeLog.pre-2-4
@@ -1,5 +1,16 @@
2002-10-11 Matthias Clasen <maclas@gmx.de>
+ * examples/gtkdial/gtkdial.c (gtk_dial_destroy):
+ * docs/tutorial/gtk-tut.sgml: Prevent segfault from double destroy.
+
+ * gdk/x11/gdkwindow-x11.c (gdk_window_new): Typo fix.
+
+ * gtk/gtkimagemenuitem.c (gtk_image_menu_item_new_from_stock):
+ Clarify the docs.
+
+ * gtk/gtkmenuitem.c (gtk_menu_item_set_accel_path): Mention
+ gtk_menu_set_accel_group in the docs.
+
* gdk/x11/gdkwindow-x11.c (gdk_window_set_skip_pager_hint):
* gdk/gdkdisplay.c (gdk_display_set_pointer_hooks): Fix
doc comments.
diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index 78d4c46d95..1995b1bee6 100644
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,5 +1,16 @@
2002-10-11 Matthias Clasen <maclas@gmx.de>
+ * examples/gtkdial/gtkdial.c (gtk_dial_destroy):
+ * docs/tutorial/gtk-tut.sgml: Prevent segfault from double destroy.
+
+ * gdk/x11/gdkwindow-x11.c (gdk_window_new): Typo fix.
+
+ * gtk/gtkimagemenuitem.c (gtk_image_menu_item_new_from_stock):
+ Clarify the docs.
+
+ * gtk/gtkmenuitem.c (gtk_menu_item_set_accel_path): Mention
+ gtk_menu_set_accel_group in the docs.
+
* gdk/x11/gdkwindow-x11.c (gdk_window_set_skip_pager_hint):
* gdk/gdkdisplay.c (gdk_display_set_pointer_hooks): Fix
doc comments.
diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 78d4c46d95..1995b1bee6 100644
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,5 +1,16 @@
2002-10-11 Matthias Clasen <maclas@gmx.de>
+ * examples/gtkdial/gtkdial.c (gtk_dial_destroy):
+ * docs/tutorial/gtk-tut.sgml: Prevent segfault from double destroy.
+
+ * gdk/x11/gdkwindow-x11.c (gdk_window_new): Typo fix.
+
+ * gtk/gtkimagemenuitem.c (gtk_image_menu_item_new_from_stock):
+ Clarify the docs.
+
+ * gtk/gtkmenuitem.c (gtk_menu_item_set_accel_path): Mention
+ gtk_menu_set_accel_group in the docs.
+
* gdk/x11/gdkwindow-x11.c (gdk_window_set_skip_pager_hint):
* gdk/gdkdisplay.c (gdk_display_set_pointer_hooks): Fix
doc comments.
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index fcea15b2f8..61f5a70af5 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,5 +1,16 @@
2002-10-11 Matthias Clasen <maclas@gmx.de>
+ * gtk/tmpl/gtkimagemenuitem.sgml: Add a bit.
+
+ * gtk/tmpl/gtkimage.sgml: Fix example.
+
+ * gtk/tmpl/gtkrc.sgml: Spelling fixes.
+
+ * gdk-pixbuf/tmpl/refcounting.sgml: Remove documentation for
+ non-longer-present last-unref hook.
+
+ * gtk/tmpl/gtkfilesel.sgml: s/GtkCList/GtkTreeView/.
+
* gdk-pixbuf/gdk-pixbuf-sections.txt: Add some missing symbols.
* gdk/gdk-sections.txt: Add some missing symbols.
diff --git a/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml b/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml
index 71521d38da..7067ea2980 100644
--- a/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml
@@ -40,42 +40,11 @@ Functions for reference counting and memory management on pixbufs.
responsibility to free the pixel array.
</para>
- <para>
- As an extension to traditional reference counting, #GdkPixbuf
- structures support defining a handler for the last unref
- operation. If g_object_unref() is called on a #GdkPixbuf
- structure that has a reference count of 1, i.e. its last
- reference, then the pixbuf's last unref handler function will be
- called. It is up to this function to determine whether to
- finalize the pixbuf using gdk_pixbuf_finalize() or to just
- continue execution. This can be used to implement a pixbuf cache
- efficiently; please see the programmer's documentation for
- details.
- </para>
-
-<!-- FIXME: link the last sentence above to the relevant section of
- the programmer's docs.
--->
-
<!-- ##### SECTION See_Also ##### -->
<para>
#GdkPixbuf, gdk_pixbuf_new_from_data().
</para>
-<!-- ##### USER_FUNCTION GdkPixbufDestroyNotify ##### -->
- <para>
- A function of this type is responsible for freeing the pixel array
- of a pixbuf. The gdk_pixbuf_new_from_data() function lets you
- pass in a pre-allocated pixel array so that a pixbuf can be
- created from it; in this case you will need to pass in a function
- of #GdkPixbufDestroyNotify so that the pixel data can be freed
- when the pixbuf is finalized.
- </para>
-
-@pixels: The pixel array of the pixbuf that is being finalized.
-@data: User closure data.
-
-
<!-- ##### FUNCTION gdk_pixbuf_ref ##### -->
<para>
@@ -93,3 +62,17 @@ Functions for reference counting and memory management on pixbufs.
@pixbuf:
+<!-- ##### USER_FUNCTION GdkPixbufDestroyNotify ##### -->
+ <para>
+ A function of this type is responsible for freeing the pixel array
+ of a pixbuf. The gdk_pixbuf_new_from_data() function lets you
+ pass in a pre-allocated pixel array so that a pixbuf can be
+ created from it; in this case you will need to pass in a function
+ of #GdkPixbufDestroyNotify so that the pixel data can be freed
+ when the pixbuf is finalized.
+ </para>
+
+@pixels: The pixel array of the pixbuf that is being finalized.
+@data: User closure data.
+
+
diff --git a/docs/reference/gtk/tmpl/gtkfilesel.sgml b/docs/reference/gtk/tmpl/gtkfilesel.sgml
index f64024db1c..731321cb2a 100644
--- a/docs/reference/gtk/tmpl/gtkfilesel.sgml
+++ b/docs/reference/gtk/tmpl/gtkfilesel.sgml
@@ -121,7 +121,7 @@ The #GtkFileSelection struct contains the following #GtkWidget fields:
<!-- ##### FUNCTION gtk_file_selection_new ##### -->
<para>
-Creates a new file selection dialog box. By default it will contain a #GtkCList of the application's current working directory, and a file listing. Operation buttons that allow the user to create a directory, delete files and rename files, are also present.
+Creates a new file selection dialog box. By default it will contain a #GtkTreeView of the application's current working directory, and a file listing. Operation buttons that allow the user to create a directory, delete files and rename files, are also present.
</para>
@title: a message that will be placed in the file requestor's titlebar.
diff --git a/docs/reference/gtk/tmpl/gtkimage.sgml b/docs/reference/gtk/tmpl/gtkimage.sgml
index 68eb6ea3a1..af6327c4fa 100644
--- a/docs/reference/gtk/tmpl/gtkimage.sgml
+++ b/docs/reference/gtk/tmpl/gtkimage.sgml
@@ -40,12 +40,12 @@ on the image, such as button clicks, place the image inside a
<title>Handling button press events on a
<structname>GtkImage</structname>.</title>
<programlisting>
- static void
+ static gboolean
button_press_callback (GtkWidget *event_box,
GdkEventButton *event,
gpointer data)
{
- g_print ("Event box clicked at coordinates &percnt;d,&percnt;d\n",
+ g_print ("Event box clicked at coordinates &percnt;f,&percnt;f\n",
event->x, event->y);
/* Returning TRUE means we handled the event, so the signal
diff --git a/docs/reference/gtk/tmpl/gtkimagemenuitem.sgml b/docs/reference/gtk/tmpl/gtkimagemenuitem.sgml
index 79d86a1168..d9c35fb722 100644
--- a/docs/reference/gtk/tmpl/gtkimagemenuitem.sgml
+++ b/docs/reference/gtk/tmpl/gtkimagemenuitem.sgml
@@ -2,11 +2,15 @@
GtkImageMenuItem
<!-- ##### SECTION Short_Description ##### -->
-
+a menu item with an icon.
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+A GtkImageMenuItem is a menu item which has an icon next to the text label.
+</para>
+<para>
+Note that the user can disable display of menu icons, so make sure to still
+fill in the text label.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/docs/reference/gtk/tmpl/gtkrc.sgml b/docs/reference/gtk/tmpl/gtkrc.sgml
index d563bbaf75..0f767fb6ab 100644
--- a/docs/reference/gtk/tmpl/gtkrc.sgml
+++ b/docs/reference/gtk/tmpl/gtkrc.sgml
@@ -738,7 +738,7 @@ Parses a color in the <link linkend="color-format">format</link> expected in a R
@scanner: a #GtkScanner
@color: a pointer to a #GtkColor structure in which to store the result
-@Returns: %G_TOKEN_NONE if parsing suceeded, otherwise the token
+@Returns: %G_TOKEN_NONE if parsing succeeded, otherwise the token
that was expected but not found.
@@ -751,7 +751,7 @@ in a RC file.
@scanner: a #GtkScanner (must be initialized for parsing an RC file)
@state: A pointer to a #GtkStateType variable in which to
store the result.
-@Returns: %G_TOKEN_NONE if parsing suceeded, otherwise the token
+@Returns: %G_TOKEN_NONE if parsing succeeded, otherwise the token
that was expected but not found.
@@ -764,7 +764,7 @@ in a RC file.
@scanner: a #GtkScanner (must be initialized for parsing an RC file)
@priority: A pointer to #GtkPathPriorityType variable in which
to store the result.
-@Returns: %G_TOKEN_NONE if parsing suceeded, otherwise the token
+@Returns: %G_TOKEN_NONE if parsing succeeded, otherwise the token
that was expected but not found.
diff --git a/docs/tutorial/gtk-tut.sgml b/docs/tutorial/gtk-tut.sgml
index 53325ed438..6f76b2223b 100755
--- a/docs/tutorial/gtk-tut.sgml
+++ b/docs/tutorial/gtk-tut.sgml
@@ -15101,7 +15101,10 @@ gtk_dial_destroy (GtkObject *object)
dial = GTK_DIAL (object);
if (dial-&gt;adjustment)
- g_object_unref (GTK_OBJECT (dial-&gt;adjustment));
+ {
+ g_object_unref (GTK_OBJECT (dial-&gt;adjustment));
+ dial-&gt;adjustment = NULL;
+ }
if (GTK_OBJECT_CLASS (parent_class)-&gt;destroy)
(* GTK_OBJECT_CLASS (parent_class)-&gt;destroy) (object);
diff --git a/examples/gtkdial/gtkdial.c b/examples/gtkdial/gtkdial.c
index f535081bdb..2ca738edb4 100644
--- a/examples/gtkdial/gtkdial.c
+++ b/examples/gtkdial/gtkdial.c
@@ -146,8 +146,11 @@ gtk_dial_destroy (GtkObject *object)
dial = GTK_DIAL (object);
- if (dial->adjustment)
- g_object_unref (GTK_OBJECT (dial->adjustment));
+ if (dial->adjustment)
+ {
+ g_object_unref (GTK_OBJECT (dial->adjustment));
+ dial->adjustment = NULL;
+ }
if (GTK_OBJECT_CLASS (parent_class)->destroy)
(* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
diff --git a/gdk/x11/gdkwindow-x11.c b/gdk/x11/gdkwindow-x11.c
index a715af5e84..9cd5f22167 100644
--- a/gdk/x11/gdkwindow-x11.c
+++ b/gdk/x11/gdkwindow-x11.c
@@ -341,7 +341,7 @@ set_wm_protocols (GdkWindow *window)
* @attributes_mask: mask indicating which fields in @attributes are valid
*
* Creates a new #GdkWindow using the attributes from
- * @attributes. Seep #GdkWindowAttr and #GdkWindowAttributesType for
+ * @attributes. See #GdkWindowAttr and #GdkWindowAttributesType for
* more details. Note: to use this on displays other than the default
* display, @parent must be specified.
*
diff --git a/gtk/gtkimagemenuitem.c b/gtk/gtkimagemenuitem.c
index fa349474b4..e9b923151d 100644
--- a/gtk/gtkimagemenuitem.c
+++ b/gtk/gtkimagemenuitem.c
@@ -356,11 +356,11 @@ gtk_image_menu_item_new_with_mnemonic (const gchar *label)
* stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
* and #GTK_STOCK_APPLY.
*
- * If you want this menu item to have changeable accelerators, then
- * pass in %NULL for @accel_group call gtk_menu_item_set_accel_path()
- * with an appropriate path for the menu item, then use gtk_stock_lookup()
- * too look up the standard accelerator for the stock item and
- * if one is found, call gtk_accel_map_add_entry() to register it.
+ * If you want this menu item to have changeable accelerators, then pass in
+ * %NULL for accel_group. Next call gtk_menu_item_set_accel_path() with an
+ * appropriate path for the menu item, use gtk_stock_lookup() to look up the
+ * standard accelerator for the stock item, and if one is found, call
+ * gtk_accel_map_add_entry() to register it.
**/
GtkWidget*
gtk_image_menu_item_new_from_stock (const gchar *stock_id,
diff --git a/gtk/gtkmenuitem.c b/gtk/gtkmenuitem.c
index c510a09e4f..15dedcf96f 100644
--- a/gtk/gtkmenuitem.c
+++ b/gtk/gtkmenuitem.c
@@ -1147,6 +1147,9 @@ _gtk_menu_item_refresh_accel_path (GtkMenuItem *menu_item,
* This function is basically a convenience wrapper that handles calling
* gtk_widget_set_accel_path() with the appropriate accelerator group for
* the menu item.
+ *
+ * Note that you do need to set an accelerator on the parent menu with
+ * gtk_menu_set_accel_group() for this to work.
*/
void
gtk_menu_item_set_accel_path (GtkMenuItem *menu_item,