Updated comment

This commit is contained in:
Kristian Sloth Lauszus 2013-02-21 22:33:31 +01:00
parent 8a22dd66e7
commit f2410f8b30

5
SPP.h
View file

@ -166,6 +166,7 @@ public:
/** /**
* Used to print strings stored in flash. * Used to print strings stored in flash.
* Use "SerialBT.print(F("String"));" to print a string stored in flash.
* @param ifsh String to send - see: http://playground.arduino.cc/Learning/Memory. * @param ifsh String to send - see: http://playground.arduino.cc/Learning/Memory.
*/ */
void print(const __FlashStringHelper *ifsh) { printFlashString(ifsh,false); }; void print(const __FlashStringHelper *ifsh) { printFlashString(ifsh,false); };
@ -175,8 +176,8 @@ public:
*/ */
void println(const __FlashStringHelper *ifsh) { printFlashString(ifsh,true); }; void println(const __FlashStringHelper *ifsh) { printFlashString(ifsh,true); };
/** /**
* Helper function to convert from a string stored in flash to a string in ram. * Helper function to print a string stored in flash.
* @param ifsh String to convert. * @param ifsh String stored in flash you want to print.
* @param newline Set this to true to include newline and carriage return. * @param newline Set this to true to include newline and carriage return.
*/ */
void printFlashString(const __FlashStringHelper *ifsh, bool newline); void printFlashString(const __FlashStringHelper *ifsh, bool newline);