From 7d30332bab2af5503ecf0790845b6aec47f43ef1 Mon Sep 17 00:00:00 2001 From: Mathieu Lacage Date: Thu, 4 Nov 2004 14:55:05 +0000 Subject: forgot to add this file. --- docs/reference/gobject/tut_tools.xml | 58 ++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 docs/reference/gobject/tut_tools.xml (limited to 'docs') diff --git a/docs/reference/gobject/tut_tools.xml b/docs/reference/gobject/tut_tools.xml new file mode 100644 index 000000000..266e4152a --- /dev/null +++ b/docs/reference/gobject/tut_tools.xml @@ -0,0 +1,58 @@ + + GObject related tools + + + Debugging reference count problems + + + The reference counting scheme used by GObject does solve quite + a few memory management problems but also introduces new sources of bugs. + In large applications, finding the exact spot where a the reference count + of an Object is not properly handled can be very difficult. Hopefully, + there exist at a too named refdbg/ + which can be used to automate the task of tracking down the location + of invalid code with regard to reference counting. This application + intercepts the reference counting calls and tries to detect invalid behavior. + It suports a filter-rule mechanism to let you trace only the objects you are + interested in and it can be used together with gdb. + + + + + Writing API docs + + The API documentation for most of the Glib, GObject, GTK+ and GNOME + libraries is built with a combination of complex tools. Typically, the part of + the documentation which describes the behavior of each function is extracted + from the specially-formatted source code comments by a tool named gtk-doc which + generates docbook xml and merges this docbook xml with a set of master xml + docbook files. These xml docbook files are finally processed with xsltproc + (a small program part of the libxslt library) to generate the final html + output. Other tools can be used to generate pdf output from the source xml. + The following code excerpt shows what these comments look like. + +/** + * gtk_widget_freeze_child_notify: + * @widget: a #GtkWidget + * + * Stops emission of "child-notify" signals on @widget. The signals are + * queued until gtk_widget_thaw_child_notify() is called on @widget. + * + * This is the analogue of g_object_freeze_notify() for child properties. + **/ +void +gtk_widget_freeze_child_notify (GtkWidget *widget) +{ +... + + + + The great thoroughful + documentation + on how to setup and use gtk-doc in your + project is provided on the gnome developer website. + gtk-doc generates + + + + -- cgit v1.2.1