From: Philip Withnall <philip@tecnocode.co.uk>
Date: Thu, 16 Aug 2012 18:19:07 +0000 (+0200)
Subject: doclets/gtkdoc: Add gtk-doc headers for property accessor ‘result_length’ parameters
X-Git-Tag: 0.37.1~3^2~149
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=154ff25d16594692f8b2329ff23bbaa3edf915ba;p=thirdparty%2Fvala.git

doclets/gtkdoc: Add gtk-doc headers for property accessor ‘result_length’ parameters

When getting or setting arrays, Vala generates input or output
result length parameters, which need to have some (boilerplate)
documentation.
---

diff --git a/src/doclets/gtkdoc/generator.vala b/src/doclets/gtkdoc/generator.vala
index 985d660e2..e904d77ee 100644
--- a/src/doclets/gtkdoc/generator.vala
+++ b/src/doclets/gtkdoc/generator.vala
@@ -621,6 +621,13 @@ It is important that your <link linkend=\"GValue\"><type>GValue</type></link> ho
 			getter_gcomment.returns = "the value of the %s property".printf (get_docbook_link (prop));
 			getter_gcomment.brief_comment = "Get and return the current value of the %s property.".printf (get_docbook_link (prop));
 
+			if (prop.property_type != null && prop.property_type.data_type is Api.Array) {
+				var array_type = prop.property_type.data_type;
+				for (uint dim = 1; array_type != null && array_type is Api.Array; dim++, array_type = ((Api.Array) array_type).data_type) {
+					gcomment.headers.add (new Header ("result_length%u".printf (dim), "return location for the length of the property's value"));
+				}
+			}
+
 			/* Copy versioning headers such as deprecation and since lines. */
 			getter_gcomment.versioning = gcomment.versioning;
 		}
@@ -631,6 +638,13 @@ It is important that your <link linkend=\"GValue\"><type>GValue</type></link> ho
 			setter_gcomment.headers.add (new Header ("value", "the new value of the %s property".printf (get_docbook_link (prop)), 2));
 			setter_gcomment.brief_comment = "Set the value of the %s property to @value.".printf (get_docbook_link (prop));
 
+			if (prop.property_type != null && prop.property_type.data_type is Api.Array) {
+				var array_type = prop.property_type.data_type;
+				for (uint dim = 1; array_type != null && array_type is Api.Array; dim++, array_type = ((Api.Array) array_type).data_type) {
+					gcomment.headers.add (new Header ("value_length%u".printf (dim), "length of the property's new value"));
+				}
+			}
+
 			/* Copy versioning headers such as deprecation and since lines. */
 			setter_gcomment.versioning = gcomment.versioning;
 		}