From: Simon McVittie <smcv@collabora.com>
Date: Mon, 12 Sep 2022 12:17:09 +0000 (+0100)
Subject: dbus-marshal-recursive: Correct an incorrect comment
X-Git-Tag: dbus-1.15.4~39^2~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=606795f90868c2cb3fd83f506bf7dae090d56ff5;p=thirdparty%2Fdbus.git

dbus-marshal-recursive: Correct an incorrect comment

array_reader_check_finished() no longer returns a type, only a boolean,
so this comment isn't accurate any more.

Signed-off-by: Simon McVittie <smcv@collabora.com>
---

diff --git a/dbus/dbus-marshal-recursive.c b/dbus/dbus-marshal-recursive.c
index 6ad49ace1..6aa513cfc 100644
--- a/dbus/dbus-marshal-recursive.c
+++ b/dbus/dbus-marshal-recursive.c
@@ -304,15 +304,12 @@ variant_reader_recurse (DBusTypeReader *sub,
 #endif
 }
 
+/* return true if no more elements remain */
 static dbus_bool_t
 array_reader_check_finished (const DBusTypeReader *reader)
 {
   int end_pos;
 
-  /* return the array element type if elements remain, and
-   * TYPE_INVALID otherwise
-   */
-
   end_pos = reader->u.array.start_pos + array_reader_get_array_len (reader);
 
   _dbus_assert (reader->value_pos <= end_pos);