Skip to content

GitLab

Commit a9b71314 authored by Matthias Clasen's avatar Matthias Clasen
Browse files

Lots of trivial doc fixes.

parent 5591c434
Hide whitespace changes
Inline Side-by-side
Showing with 121 additions and 48 deletions
ChangeLog
View file @ a9b71314
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.
......
ChangeLog.pre-2-10
View file @ a9b71314
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.
......
ChangeLog.pre-2-2
View file @ a9b71314
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.
......
ChangeLog.pre-2-4
View file @ a9b71314
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.
......
ChangeLog.pre-2-6
View file @ a9b71314
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.
......
ChangeLog.pre-2-8
View file @ a9b71314
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.
......
docs/reference/ChangeLog
View file @ a9b71314
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.
......
docs/reference/gdk-pixbuf/tmpl/refcounting.sgml
View file @ a9b71314
......@@ -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.
docs/reference/gtk/tmpl/gtkfilesel.sgml
View file @ a9b71314
......@@ -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.
......
docs/reference/gtk/tmpl/gtkimage.sgml
View file @ a9b71314
......@@ -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
......
docs/reference/gtk/tmpl/gtkimagemenuitem.sgml
View file @ a9b71314
......@@ -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 ##### -->
......
docs/reference/gtk/tmpl/gtkrc.sgml
View file @ a9b71314
......@@ -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.
......
docs/tutorial/gtk-tut.sgml
View file @ a9b71314
......@@ -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);
......
examples/gtkdial/gtkdial.c
View file @ a9b71314
......@@ -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);
......
gdk/x11/gdkwindow-x11.c
View file @ a9b71314
......@@ -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.
*
......
gtk/gtkimagemenuitem.c
View file @ a9b71314
......@@ -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,
......
gtk/gtkmenuitem.c
View file @ a9b71314
......@@ -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,
......
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