Revision 1:6b33efd3caee, committed 2015-03-13

Comitter:

jdanner3

Date:

Fri Mar 13 14:37:56 2015 +0000

Parent:

0:975087cba076

Commit message:

Updated docs

Changed in this revision

diff -r 975087cba076 -r 6b33efd3caee uLCD_Screensaver.cpp
--- a/uLCD_Screensaver.cpp	Fri Mar 13 08:41:02 2015 +0000
+++ b/uLCD_Screensaver.cpp	Fri Mar 13 14:37:56 2015 +0000
@@ -4,7 +4,7 @@
 #include "mbed.h"
 #include "uLCD_4DGL.h"
     
-// Determine if the screensaver should be shown
+/** Determine if the screensaver should be shown */
 void uLCD_4DGL :: checkActiveScreenTime() {
     time(&now);
     if (difftime(now, lastDisplayActivityTime) >= max_active_screen_interval) {
@@ -16,9 +16,9 @@
     }
 }
 
-// Whenever a change is made to the LCD screen that is not part of the 
-// screensaver graphics method, it is reported and the last screen
-// activity time is updatd
+/** Whenever a change is made to the LCD screen that is not part of the 
+ screensaver graphics method, it is reported and the last screen
+ activity time is updated */
 void uLCD_4DGL :: reportScreenInteraction() {
     time(&lastDisplayActivityTime); // indicate that the screen is still active
     if (inScreensaverMode) {
@@ -26,7 +26,7 @@
     }   
 }
 
-// Initialize the screen saver
+/** Initialize the screen saver */
 void uLCD_4DGL :: enableScreensaverMode() {
     inScreensaverMode = true;
     backupStateOfScreen(); 
@@ -37,7 +37,7 @@
     #endif
 }
 
-// Close the screen saver
+/** Close the screen saver */
 void uLCD_4DGL :: exitScreensaverMode() {
     inScreensaverMode = false;
     restoreStateOfScreen();
@@ -47,22 +47,22 @@
     #endif 
 }
 
-// Set the timeout interval for active screen
+/** Set the timeout interval for active screen */
 void uLCD_4DGL :: setActiveScreenInterval(int newInterval) {
     max_active_screen_interval = newInterval;   
 }
 
-// Get the timeout interval for active screen
+/** Get the timeout interval for active screen */
 int uLCD_4DGL :: getActiveScreenInterval() {
     return max_active_screen_interval;   
 }
 
-// Return whether the LCD is currently in screen saver mode
+/**Return whether the LCD is currently in screen saver mode */
 bool uLCD_4DGL :: isInScreensaverMode() {
     return inScreensaverMode;
 }
 
-// Backup the current pixels of the display to the sd card
+/** Backup the current pixels of the display to the sd card */
 void uLCD_4DGL :: backupStateOfScreen() {
     FILE* data = fopen("/sd/pixelData.txt","w");
     fclose(data);