3DPrinting/Prusa-Firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update documentation.

Browse source
This commit is contained in:
Marek Bel 2018-09-18 17:48:11 +02:00
parent a7fdfdd258
commit 05d3b7032d
2 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Firmware/lcd.cpp
View file

@ -686,6 +686,9 @@ LongTimer lcd_timeoutToStatus;
//! @brief Was button clicked? //! @brief Was button clicked?
//! //!
//! Consume click event, following call would return 0. //! Consume click event, following call would return 0.
//! See #LCD_CLICKED macro for version not consuming the event.
//!
//! Generally is used in modal dialogs.
//! //!
//! @retval 0 not clicked //! @retval 0 not clicked
//! @retval nonzero clicked //! @retval nonzero clicked

13
Firmware/lcd.h
View file

@ -1,4 +1,4 @@
//lcd.h //! @file
#ifndef _LCD_H #ifndef _LCD_H
#define _LCD_H #define _LCD_H
@ -186,7 +186,16 @@ extern void lcd_buttons_update(void);
#define EN_A (1<<BLEN_A) #define EN_A (1<<BLEN_A)
#define BLEN_C 2 #define BLEN_C 2
#define EN_C (1<<BLEN_C) #define EN_C (1<<BLEN_C)
//! @brief Was button clicked?
//!
//! Doesn't consume button click event. See lcd_clicked()
//! for function consuming the event.
//!
//! Generally is used in non-modal menus.
//!
//! @retval 0 button was not clicked
//! @retval 1 button was clicked
#define LCD_CLICKED (lcd_buttons&EN_C) #define LCD_CLICKED (lcd_buttons&EN_C)
//////////////////////// ////////////////////////