Diff: SWUpdate.h

Revision:

1:208de08b1a19

Parent:

0:e221363f7942

Child:

2:ef2ac9627546

--- a/SWUpdate.h	Mon Apr 21 00:20:05 2014 +0000
+++ b/SWUpdate.h	Sat Jun 14 15:59:02 2014 +0000
@@ -4,11 +4,26 @@
 #ifndef SWUPDATE_H
 #define SWUPDATE_H
 
+/// After downloading, the user can choose what happens next.
 typedef enum {
     DEFER_REBOOT,
     AUTO_REBOOT
 } Reboot_T;
 
+/// This API performs some processing to see if a web server
+/// has an updated version of software. If it does, then it
+/// will try to download it. If that succeeds, then it can
+/// optionally reboot to activate the new software.
+///
+/// @todo check the freshly downloaded sw integrity. Since we have
+///     to remove the old .bin file before the new one will execute,
+///     it is in the device' best interest to ensure that new one
+///     is a good one.
+///
+/// @param url is a pointer to a text string of the url from which to download.
+/// @param name is the base filename of the binary file.
+/// @param reboot determines whether to automatically reboot to activate the new bin.
+///
 bool SoftwareUpdate(const char *url, const char * name, Reboot_T reboot = DEFER_REBOOT);
 
 #endif // SWUPDATE_H