Commits

F Malpartida committed f86dbe0

Minor rework of header files.

Comments (0)

Files changed (3)

 #include <inttypes.h>
 #include <util/delay.h>
 
+/*!
+ @defined 
+ @abstract   Enables IO digitalRead/digitalWrite fall back for non-AVR
+             architectures.
+ */
 #ifndef __AVR__
 #define FIO_FALLBACK
 #endif
 
 // PUBLIC CONSTANTS DEFINITIONS
 // ---------------------------------------------------------------------------
+/*!
+ @defined 
+ @abstract   Skip setting IO outputs during IO configuration or when getting
+             the output register associated to an IO pin.k
+ */
 #define SKIP 0x23
 
 // PUBLIC TYPE DEFINITIONS
 typedef uint8_t fio_bit;
 
 
-#ifndef FALLBACK
+#ifndef FIO_FALLBACK
 typedef volatile uint8_t * fio_register;
 #else
 // remove volatile to give optimizer a chance
 // Thread Safe: No
 // Extendable: Yes
 //
-// @file LCD.h
+// @file LCD.cpp
 // This file implements a basic liquid crystal library that comes as standard
 // in the Arduino SDK.
 // 
 // This is a basic implementation of the HD44780 library of the
 // Arduino SDK. This library is a refactored version of the one supplied
 // in the Arduino SDK in such a way that it simplifies its extension
-// to support other mechanism to communicate to LCDs such as I2C, Serial.
+// to support other mechanism to communicate to LCDs such as I2C, Serial, SR, ...
 // The original library has been reworked in such a way that this will be
 // the base class implementing all generic methods to command an LCD based
 // on the Hitachi HD44780 and compatible chipsets.
 // backpacks such as the I2CLCDextraIO using the PCF8574* I2C IO Expander ASIC.
 //
 //
-// This library is only compatible with Arduino's SDK version 1.0
-//
 // @version API 1.0.0
 //
 // @author F. Malpartida - fmalpartida@gmail.com
 // Thread Safe: No
 // Extendable: Yes
 //
-// @file LiquidCrystal.h
+// @file LCD.h
 // This file implements a basic liquid crystal library that comes as standard
 // in the Arduino SDK.
 // 
 // This is a basic implementation of the LiquidCrystal library of the
 // Arduino SDK. This library is a refactored version of the one supplied
 // in the Arduino SDK in such a way that it simplifies its extension
-// to support other mechanism to communicate to LCDs such as I2C, Serial.
+// to support other mechanism to communicate to LCDs such as I2C, Serial, SR, 
 // The original library has been reworked in such a way that this will be
 // the base class implementing all generic methods to command an LCD based
 // on the Hitachi HD44780 and compatible chipsets.
 // it has been extended to drive 4 and 8 bit mode control, LCDs and I2C extension
 // backpacks such as the I2CLCDextraIO using the PCF8574* I2C IO Expander ASIC.
 //
-//
-// This library is only compatible with Arduino's SDK version 1.0
-//
 // @version API 1.0.0
 //
 //