update GetHighestReceivedEventNumber comment (#17697)

project-chip · Aug 31, 2023 · 3709592 · 3709592
1 parent 5ea4cbc
commit 3709592
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/app/ReadClient.h b/src/app/ReadClient.h
@@ -186,8 +186,8 @@ class ReadClient : public Messaging::ExchangeDelegate
 
         /*
          * Get highest received event number.
-         * If application don't have this one, it clear outparam and return CHIP_NO_ERROR.
-         * if any returning error, it will fail the entire read client.
+         * If the application does not want to filter events by event number, it should call ClearValue() on aEventNumber
+         * and return CHIP_NO_ERROR.  An error return from this function will fail the entire read client interaction.
          */
         virtual CHIP_ERROR GetHighestReceivedEventNumber(Optional<EventNumber> & aEventNumber)
         {