From: Richard A. Hankins <richard.a.hankins@gmail.com>
Date: Wed, 19 Jan 2011 15:59:24 +0000 (+0000)
Subject: fix bad DBusMessageIter doc example
X-Git-Tag: dbus-1.4.4~29
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=57fab1c2196242db8fb452c98550eef0f5f2de18;p=thirdparty%2Fdbus.git

fix bad DBusMessageIter doc example

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=11190
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
---

diff --git a/dbus/dbus-message.c b/dbus/dbus-message.c
index b19697eec..442ec2ae3 100644
--- a/dbus/dbus-message.c
+++ b/dbus/dbus-message.c
@@ -1979,7 +1979,7 @@ dbus_message_iter_next (DBusMessageIter *iter)
  * #DBUS_TYPE_INVALID. You can thus write a loop as follows:
  *
  * @code
- * dbus_message_iter_init (&iter);
+ * dbus_message_iter_init (message, &iter);
  * while ((current_type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID)
  *   dbus_message_iter_next (&iter);
  * @endcode