From: Lars Op den Kamp <lars@opdenkamp.eu>
Date: Mon, 23 Apr 2012 12:55:39 +0000 (+0200)
Subject: cec: updated documentation for CBCecMenuStateChanged because we can't suppress displa... 
X-Git-Tag: upstream/2.2.0~1^2~29^2^2~62
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=6ad51ff559b2fc75ce63bc35832932f00c20b925;p=deb_libcec.git

cec: updated documentation for CBCecMenuStateChanged because we can't suppress displaying the menu on the TV
---

diff --git a/include/cectypes.h b/include/cectypes.h
index ae8db71..c1cc1af 100644
--- a/include/cectypes.h
+++ b/include/cectypes.h
@@ -1083,9 +1083,10 @@ typedef struct ICECCallbacks
    * @brief Transfer a menu state change to the client.
    * Transfer a menu state change to the client. If the command returns 1, then the change will be processed by
    * the busdevice. If 0, then the state of the busdevice won't be changed, and will always be kept 'activated',
+   * @warning CEC does not allow the player to suppress the menu state change on the TV, so the menu on the TV will always be displayed, whatever the return value of this method is.
    * so keypresses are always routed.
    * @param newVal The new value.
-   * @return 1 when this change should be processed by the CCECBusDevice, false otherwise.
+   * @return 1 when libCEC should use this new value, 0 otherwise.
    */
   CBCecMenuStateChangedType CBCecMenuStateChanged;