From: Philip Withnall <philip@tecnocode.co.uk>
Date: Thu, 16 Aug 2012 18:22:31 +0000 (+0200)
Subject: doclets/gtkdoc: Add a gtk-doc header for non-static delegates ‘user_data’
X-Git-Tag: 0.37.1~3^2~148
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f945b7ddd5fdccf1abdd7f5753f76cbba3635eb0;p=thirdparty%2Fvala.git

doclets/gtkdoc: Add a gtk-doc header for non-static delegates ‘user_data’

Non-static delegates take in a generated ‘user_data’ parameter,
which needs some (boilerplate) documentation.
---

diff --git a/src/doclets/gtkdoc/generator.vala b/src/doclets/gtkdoc/generator.vala
index e904d77ee..af293912b 100644
--- a/src/doclets/gtkdoc/generator.vala
+++ b/src/doclets/gtkdoc/generator.vala
@@ -681,6 +681,10 @@ It is important that your <link linkend=\"GValue\"><type>GValue</type></link> ho
 			visit_thrown_error_domain (ex);
 		}
 
+		if (!d.is_static) {
+			add_custom_header ("user_data", "data to pass to the delegate function", {"closure"});
+		}
+
 		add_symbol (d.get_filename(), d.get_cname(), d.documentation);
 
 		current_headers = old_headers;