Ver código fonte

Update documentation.

Marek Bel 5 anos atrás
pai
commit
05d3b7032d
2 arquivos alterados com 14 adições e 2 exclusões
  1. 3 0
      Firmware/lcd.cpp
  2. 11 2
      Firmware/lcd.h

+ 3 - 0
Firmware/lcd.cpp

@@ -686,6 +686,9 @@ LongTimer lcd_timeoutToStatus;
 //! @brief Was button clicked?
 //!
 //! 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 nonzero clicked

+ 11 - 2
Firmware/lcd.h

@@ -1,4 +1,4 @@
-//lcd.h
+//! @file
 #ifndef _LCD_H
 #define _LCD_H
 
@@ -186,7 +186,16 @@ extern void lcd_buttons_update(void);
 #define EN_A (1<<BLEN_A)
 #define BLEN_C 2 
 #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)
 
 ////////////////////////