Newmenus: Update MENU_TIMEOUT doc

This commit is contained in:
Valentin Grünbacher 2014-05-27 10:32:28 +02:00
parent 3b87c428dc
commit c91d67912b

View File

@ -111,11 +111,12 @@ native menu_items(menu);
* when the item is less than 0 (i.e. calling this from a cancelled menu will * when the item is less than 0 (i.e. calling this from a cancelled menu will
* result in an error). * result in an error).
* *
* Starting with 1.8.3 this allows to select a menu timeout similar to the * Starting with 1.8.3 this allows to specify a menu timeout similar to the
* show_menu native. If the menu exists on the client past the timeout *any* * show_menu native. If the menu exists on the client past the timeout *any*
* further action will send the MENU_TIMEOUT status code to the menu handler. * further action will send the MENU_TIMEOUT status code to the menu handler.
* That includes actions which would otherwise send MENU_EXIT, including * That includes actions which would otherwise send MENU_EXIT, such as the
* client disconnect and calling menu_cancel or menu_destroy on a live menu. * client selecting an item or disconnecting and calling menu_cancel or
* menu_destroy on a live menu.
* *
* @param id Client index. * @param id Client index.
* @param menu Menu resource identifier. * @param menu Menu resource identifier.