Tizen 2.1 base
[platform/upstream/glib2.0.git] / docs / reference / gobject / html / tools-gtkdoc.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Writing API docs</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GObject Reference Manual">
8 <link rel="up" href="pt03.html" title="Part V. Related Tools">
9 <link rel="prev" href="tools-refdb.html" title="Debugging reference count problems">
10 <link rel="next" href="api-index-full.html" title="Index">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
16 <td><a accesskey="p" href="tools-refdb.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
17 <td><a accesskey="u" href="pt03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
18 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
19 <th width="100%" align="center">GObject Reference Manual</th>
20 <td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
21 </tr></table>
22 <div class="chapter">
23 <div class="titlepage"><div><div><h2 class="title">
24 <a name="tools-gtkdoc"></a>Writing API docs</h2></div></div></div>
25 <p>The API documentation for most of the GLib, GObject, GTK+ and GNOME
26     libraries is built with a combination of complex tools. Typically, the part of 
27     the documentation which describes the behavior of each function is extracted
28     from the specially-formatted source code comments by a tool named gtk-doc which
29     generates DocBook XML and merges this DocBook XML with a set of master XML 
30     DocBook files. These XML DocBook files are finally processed with xsltproc
31     (a small program part of the libxslt library) to generate the final HTML
32     output. Other tools can be used to generate PDF output from the source XML.
33     The following code excerpt shows what these comments look like.
34     </p>
35 <pre class="programlisting">
36 /**
37  * gtk_widget_freeze_child_notify:
38  * @widget: a #GtkWidget
39  * 
40  * Stops emission of "child-notify" signals on @widget. The signals are
41  * queued until gtk_widget_thaw_child_notify() is called on @widget. 
42  *
43  * This is the analogue of g_object_freeze_notify() for child properties.
44  **/
45 void
46 gtk_widget_freeze_child_notify (GtkWidget *widget)
47 {
48 ...
49       </pre>
50 <p>
51     </p>
52 <p>
53     Thorough
54     <a class="ulink" href="http://library.gnome.org/devel/gtk-doc-manual/stable/" target="_top">documentation</a>
55     on how to set up and use gtk-doc in your project is provided on the
56     <a class="ulink" href="http://library.gnome.org/devel/" target="_top">GNOME developer website</a>.
57     </p>
58 </div>
59 <div class="footer">
60 <hr>
61           Generated by GTK-Doc V1.18</div>
62 </body>
63 </html>