Martin Sivak / EFM32_SegmentLCD

Fork of EFM32 Segment LCD library - used as pull request source for bugfixes

Fork of EFM32_SegmentLCD by Silicon Labs

Files at this revision

API Documentation at this revision

Revision 1:5335eb33bfcb, committed 2015-03-17

Comitter:
Steven Cooreman
Date:
Tue Mar 17 11:51:52 2015 -0500
Parent:
0:559902e88130
Child:
2:ee5ef7bb4fb0
Commit message:
Documentation update

Changed in this revision

EFM32_SegmentLCD.h Show annotated file Show diff for this revision Revisions of this file
segmentlcdconfig_stk_g.h Show annotated file Show diff for this revision Revisions of this file
segmentlcdconfig_stk_gg.h Show annotated file Show diff for this revision Revisions of this file
segmentlcdconfig_stk_lg.h Show annotated file Show diff for this revision Revisions of this file
segmentlcdconfig_stk_tg.h Show annotated file Show diff for this revision Revisions of this file
segmentlcdconfig_stk_wg.h Show annotated file Show diff for this revision Revisions of this file 
--- a/EFM32_SegmentLCD.h	Tue Mar 17 11:45:46 2015 -0500
+++ b/EFM32_SegmentLCD.h	Tue Mar 17 11:51:52 2015 -0500
@@ -51,29 +51,29 @@
 	 */
 	EFM32_SegmentLCD();
 
-	/*
+	/**
 	 * Switch off all elements
 	 */
 	void AllOff( void );
 
-	/*
+	/**
 	 * Switch on all elements
 	 */
 	void AllOn( void );
 
-	/*
+	/**
 	 * Switch off (clear) the alphanumeric portion of the display
 	 */
 	void AlphaNumberOff(void);
 
-	/*
+	/**
 	 * Switch specified segment on the ring on/off
 	 * anum: ring segment index
 	 * on: true to turn on, false to turn off
 	 */
 	void ARing(int anum, bool on);
 
-	/*
+	/**
 	 * Display a battery level on the LCD.
 	 * 0 = off
 	 * 1 = lowest block
@@ -82,14 +82,14 @@
 	 */
 	void Battery(int batteryLevel);
 
-	/*
+	/**
 	 * Display an energy mode ring on the LCD.
 	 * em = energy mode number to display
 	 * on = true to turn on, false to turn off.
 	 */
 	void EnergyMode(int em, bool on);
 
-	/*
+	/**
 	 * Display an unsigned integer on the alphanumeric
 	 * portion of the display as a hex value.
 	 *
@@ -97,39 +97,39 @@
 	 */
 	void LowerHex( uint32_t num );
 
-	/*
+	/**
 	 * Display a signed integer as decimal number on
 	 * the alphanumeric part of the display.
 	 */
 	void LowerNumber( int num );
 
-	/*
+	/**
 	 * Display a signed integer on the numeric part
 	 * of the display (clock area).
 	 * max = 9999, min = -9999
 	 */
 	void Number(int value);
 
-	/*
+	/**
 	 * Clear the numeric part of the display.
 	 */
 	void NumberOff(void);
 
-	/*
+	/**
 	 * Turn a predefined symbol on or off.
 	 * lcdSymbol = predefined symbol in segmentlcdconfig_*.h
 	 * on = true to turn on, false to turn off.
 	 */
 	void Symbol(lcdSymbol s, bool on);
 
-	/*
+	/**
 	 * Display an unsigned short integer as a hex value
 	 * on the numeric part of the display.
 	 * max = FFFF, min = 0
 	 */
 	void UnsignedHex(uint16_t value);
 
-	/*
+	/**
 	 * Display a 7-character string on the alphanumeric
 	 * portion of the display.
 	 */

--- a/segmentlcdconfig_stk_g.h	Tue Mar 17 11:45:46 2015 -0500
+++ b/segmentlcdconfig_stk_g.h	Tue Mar 17 11:51:52 2015 -0500
@@ -1,6 +1,6 @@
 /**************************************************************************//**
  * @file
- * @brief Segment LCD Config for the EFM32_G8xx_STK
+ * @brief Segment LCD Config for the EFM32 Gecko STK (G8xx_STK)
  * @version 3.20.5
  ******************************************************************************
  * @section License

--- a/segmentlcdconfig_stk_gg.h	Tue Mar 17 11:45:46 2015 -0500
+++ b/segmentlcdconfig_stk_gg.h	Tue Mar 17 11:51:52 2015 -0500
@@ -1,6 +1,6 @@
 /**************************************************************************//**
  * @file
- * @brief Segment LCD Config
+ * @brief Segment LCD Config for the EFM32 Giant Gecko STK (STK_3700)
  * @version 3.20.5
  ******************************************************************************
  * @section License

--- a/segmentlcdconfig_stk_lg.h	Tue Mar 17 11:45:46 2015 -0500
+++ b/segmentlcdconfig_stk_lg.h	Tue Mar 17 11:51:52 2015 -0500
@@ -1,6 +1,6 @@
 /**************************************************************************//**
  * @file
- * @brief Segment LCD Config
+ * @brief Segment LCD Config for the EFM32 Leopard Gecko STK (STK_3600)
  * @version 3.20.5
  ******************************************************************************
  * @section License

--- a/segmentlcdconfig_stk_tg.h	Tue Mar 17 11:45:46 2015 -0500
+++ b/segmentlcdconfig_stk_tg.h	Tue Mar 17 11:51:52 2015 -0500
@@ -1,6 +1,6 @@
 /**************************************************************************//**
  * @file
- * @brief Segment LCD Config for the EFM32TG_STK3300 starter kit
+ * @brief Segment LCD Config for the EFM32 Tiny Gecko STK (STK_3300)
  * @version 3.20.5
  ******************************************************************************
  * @section License

--- a/segmentlcdconfig_stk_wg.h	Tue Mar 17 11:45:46 2015 -0500
+++ b/segmentlcdconfig_stk_wg.h	Tue Mar 17 11:51:52 2015 -0500
@@ -1,6 +1,6 @@
 /**************************************************************************//**
  * @file
- * @brief Segment LCD Config
+ * @brief Segment LCD Config for the EFM32 Wonder Gecko STK (STK_3800)
  * @version 3.20.5
  ******************************************************************************
  * @section License