summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2003-06-11 22:24:25 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2003-06-11 22:24:25 +0000
commit8d629b7c1457c6ca6dad4364cb003d2ea8523cd9 (patch)
treeeeb3b260c9b9a10ddd1b217f22379e142108caf5 /doc
parent25deba96d6e02aa9ccfc1411718c06000094fced (diff)
downloadgtk-doc-8d629b7c1457c6ca6dad4364cb003d2ea8523cd9.tar.gz
One more update.
Diffstat (limited to 'doc')
-rw-r--r--doc/gnome.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/gnome.txt b/doc/gnome.txt
index 56db4cc..95243bf 100644
--- a/doc/gnome.txt
+++ b/doc/gnome.txt
@@ -22,7 +22,9 @@ Each line starts with ' * '.
The second line is the function name, optionally followed by a ':'. In
order to document signals in inline comments, use a name of the form
class::signal, e.g. GtkWidget::notify-child. For properties, use a
-name of the form class:property, e.g. GtkAlignment:top_padding.
+name of the form class:property, e.g. GtkAlignment:top-padding. Note
+that gtk-doc expects the signal and property names to be spelled with
+hyphens, not underlines.
Following the function name are the parameters, e.g. '@par1:' above.