Diff: SWUpdate.h

Revision:

6:6025fddc1af9

Parent:

5:e10f18e9b93a

Child:

9:73067ef14c30

diff -r e10f18e9b93a -r 6025fddc1af9 SWUpdate.h
--- a/SWUpdate.h	Sat Jun 14 18:24:40 2014 +0000
+++ b/SWUpdate.h	Sat Jun 14 18:27:48 2014 +0000
@@ -10,8 +10,8 @@
 
 /// After downloading, the user can choose what happens next.
 typedef enum {
-    DEFER_REBOOT,
-    AUTO_REBOOT
+    DEFER_REBOOT,   ///< Do not reboot to activate the new firmware.
+    AUTO_REBOOT     ///< Automatically reboot to activate the new firmware.
 } Reboot_T;
 
 /// This API performs some processing to see if a web server
@@ -36,7 +36,7 @@
 ///
 /// You can create the server "myprog.txt" file with this perl script (not
 /// every detail is shown, but it should be easy to figure out).
-/// <<code>>
+/// @code
 /// # Read current .txt file
 /// open (FT, "<$txt") || die("Can't read $txt.");
 /// $ver = <FT>; chomp $ver; close FT;
@@ -57,7 +57,7 @@
 /// open (FT, ">$txt") || die("Can't write update to $txt.");
 /// printf(FT "%d,%d,%d\n", $ver, $cksum,$byteCount);
 /// close FT;
-/// <</code>>
+/// @endcode
 ///
 /// @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.