David Smart / CommandProcessor

The CommandProcessor is the interface to install a run-time menu into an embedded system.

Dependents:   A_CANAdapter USB2I2C

Files at this revision

API Documentation at this revision

Revision 11:4a3cd3f2183b, committed 2011-04-23

Comitter:
WiredHome
Date:
Sat Apr 23 14:15:10 2011 +0000
Parent:
10:9e52bd1a4a71
Child:
12:a8c56bf811b9
Commit message:
Minor documentation update

Changed in this revision

CommandProcessor.c Show annotated file Show diff for this revision Revisions of this file
CommandProcessor.h Show annotated file Show diff for this revision Revisions of this file 
--- a/CommandProcessor.c	Sat Apr 23 14:04:19 2011 +0000
+++ b/CommandProcessor.c	Sat Apr 23 14:15:10 2011 +0000
@@ -26,6 +26,7 @@
 #include "CommandProcessor.h"
 
 /// This holds the single linked list of commands
+/// @verbatim
 /// +-- Head->next
 /// v
 /// +-- p       +-- n
@@ -35,6 +36,7 @@
 ///             |next|->0  |"..."          |*(callback)|
 ///                        |*(callback)    |visible    |
 ///                        |visible
+/// @endverbatim
 ///
 typedef struct CMDLINK_T {
     CMD_T * menu;                // handle to the menu item

--- a/CommandProcessor.h	Sat Apr 23 14:04:19 2011 +0000
+++ b/CommandProcessor.h	Sat Apr 23 14:15:10 2011 +0000
@@ -140,13 +140,19 @@
     initok            ///< this indicates that the menu system was successfully initialized
 } INITRESULT_T;
 
-/// Configuration options
+/// Configuration options to control startup and some runtime behavior
+///
+/// Permissible values are created by combining
+/// \li CFG_ENABLE_TERMINATE
+/// \li CFG_ENABLE_SYSTEM   
+/// \li CFG_ECHO_ON          
+/// \li CFG_CASE_INSENSITIVE
 typedef unsigned long CONFIG_T;
 
-#define CFG_ENABLE_TERMINATE 0x0001
-#define CFG_ENABLE_SYSTEM    0x0002
-#define CFG_ECHO_ON          0x2000
-#define CFG_CASE_INSENSITIVE 0x4000
+#define CFG_ENABLE_TERMINATE 0x0001 ///<- Enable the exit option
+#define CFG_ENABLE_SYSTEM    0x0002 ///<- Enable various system options (help, etc)
+#define CFG_ECHO_ON          0x2000 ///<- Initialize with command prompt Echo on
+#define CFG_CASE_INSENSITIVE 0x4000 ///<- Enable case insensitive command entry
 
 
 /// This is the type for the basic callback, when a menu pick is activated.