Blame docs/reference/gobject/html/tools-gtkdoc.html
|
Packit |
ae235b |
|
|
Packit |
ae235b |
<html>
|
|
Packit |
ae235b |
<head>
|
|
Packit |
ae235b |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
ae235b |
<title>Writing API docs: GObject Reference Manual</title>
|
|
Packit |
ae235b |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
|
Packit |
ae235b |
<link rel="home" href="index.html" title="GObject Reference Manual">
|
|
Packit |
ae235b |
<link rel="up" href="pt03.html" title="Part V. Related Tools">
|
|
Packit |
ae235b |
<link rel="prev" href="tools-refdb.html" title="Debugging reference count problems">
|
|
Packit |
ae235b |
<link rel="next" href="api-index-full.html" title="Index">
|
|
Packit |
ae235b |
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
|
|
Packit |
ae235b |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
ae235b |
</head>
|
|
Packit |
ae235b |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Writing API docs
|
|
Packit |
ae235b |
The API documentation for most of the GLib, GObject, GTK+ and GNOME
|
|
Packit |
ae235b |
libraries is built with a combination of complex tools. Typically, the part of
|
|
Packit |
ae235b |
the documentation which describes the behavior of each function is extracted
|
|
Packit |
ae235b |
from the specially-formatted source code comments by a tool named gtk-doc which
|
|
Packit |
ae235b |
generates DocBook XML and merges this DocBook XML with a set of master XML
|
|
Packit |
ae235b |
DocBook files. These XML DocBook files are finally processed with xsltproc
|
|
Packit |
ae235b |
(a small program part of the libxslt library) to generate the final HTML
|
|
Packit |
ae235b |
output. Other tools can be used to generate PDF output from the source XML.
|
|
Packit |
ae235b |
The following code excerpt shows what these comments look like.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
1
|
|
Packit |
ae235b |
2
|
|
Packit |
ae235b |
3
|
|
Packit |
ae235b |
4
|
|
Packit |
ae235b |
5
|
|
Packit |
ae235b |
6
|
|
Packit |
ae235b |
7
|
|
Packit |
ae235b |
8
|
|
Packit |
ae235b |
9
|
|
Packit |
ae235b |
10
|
|
Packit |
ae235b |
11
|
|
Packit |
ae235b |
12
|
|
Packit |
ae235b |
13
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
@widget
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
@widget
|
|
Packit |
ae235b |
@widget
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
gtk_widget_freeze_child_notify (GtkWidget *widget)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
...
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Thorough
|
|
Packit |
ae235b |
documentation
|
|
Packit |
ae235b |
on how to set up and use gtk-doc in your project is provided on the
|
|
Packit |
ae235b |
GNOME developer website.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Generated by GTK-Doc V1.27
|
|
Packit |
ae235b |
</body>
|
|
Packit |
ae235b |
</html>
|