Diff: uLCD_4D_Picaso.h

Revision:

5:ec04cd4e98ce

Parent:

4:30010dda3b34

Child:

6:70c65c7c4337

--- a/uLCD_4D_Picaso.h	Tue Mar 10 19:01:56 2015 +0000
+++ b/uLCD_4D_Picaso.h	Wed Mar 11 19:44:43 2015 +0000
@@ -1,4 +1,4 @@
-/** @file uLCD_4D_Picaso.h
+/** @headerfile uLCD_4D_Picaso.h
  *
  * This is a class to drive 4D systems screens with Picaso graphics processors
  * 
@@ -6,6 +6,8 @@
  * Copyright (c) 2014 4D Systems PTY Ltd, Sydney, Australia
  * From https://github.com/4dsystems/Picaso-Serial-Linux-Library, retrieved March 5, 2015
  *
+ * Documentation in this file is adapted from the 4D systems Picaso Serial Command Manual, Rev 1.18, Copyright (c) 2014 4D Systems.
+ *
  * All software in this library is provided without warranty; use at your own risk.
  */
 
@@ -377,7 +379,7 @@
 	 * @param Color Color of slider bar.
 	 * @param Scale Sets scale of slider position: slider can have positions from 0 to Scale.
 	 * @param Position of slider thumb. If negative, the absolute value is taken.
-	 * @return ??--TODO
+	 * @return Unknown--Serial command manual does not specify a return.
 	 */
 	uint16_t gfx_Slider(Picaso::SliderState Mode, uint16_t  X1, uint16_t  Y1, uint16_t  X2, uint16_t  Y2, Picaso::Color Color, uint16_t  Scale, uint16_t  Value);
 	
@@ -824,7 +826,7 @@
 	 * (which can modify it), and the result is read with this function.
 	 * @param Handle Pointer to string location. This is the same value passed to writeString when the space was initially written.
 	 * @param StringIn Character array in which to store the returned string.
-	 * @return ??--TODO
+	 * @return Unknown--command manual does not specify a return.
 	 */
 	uint16_t readString(uint16_t  Handle, char * StringIn);