Diff: CommandProcessor.h

Revision:

1:1c81feb2f8bd

Parent:

0:198f53da1bc8

Child:

2:14cafb06b4c5

--- a/CommandProcessor.h	Sun Mar 20 21:50:15 2011 +0000
+++ b/CommandProcessor.h	Sun Mar 20 21:54:25 2011 +0000
@@ -125,7 +125,7 @@
 /// was removed.
 /// 
 ///	@param p is a pointer to a character string
-///	@returns \see RUNRESULT_T to indicate if the CommandProcessor should continue
+///	@returns RUNRESULT_T to indicate if the CommandProcessor should continue
 ///
 typedef RUNRESULT_T (*MENU_CALLBACK)(char *p);
 
@@ -149,7 +149,7 @@
 
 /// This is the CommandProcessor interface from the user application.
 ///
-///	The user aquires a handle to this set of functions with the \see GetCommandProcessor command.
+///	The user aquires a handle to this set of functions with the GetCommandProcessor command.
 /// After this, the user may then initialize the CommandProcessor, add items to the menu,
 /// cause the CommandProcessor to run periodically, and if need be the application can end
 /// the CommandProcessor.
@@ -175,7 +175,7 @@
 	///	@param putch is a user provided function that permits the CommandProcessor to output a character
 	///	@param puts is a user provided function that permits the CommandProcessor to output a string
 	///        to which is automatically appended a \\n
-	/// @returns \see INITRESULT_T to indicate if the init was successful or failed
+	/// @returns INITRESULT_T to indicate if the init was successful or failed
 	INITRESULT_T (*Init)(
 		int defaultMenu, 
 		int caseinsensitive,
@@ -188,11 +188,11 @@
 
 	/// Add is called to add an item to the CommandProcessor menu
 	///
-	///	This passes in a reference to a user provided \see CMD_T item, which is
+	///	This passes in a reference to a user provided CMD_T item, which is
 	///	added to the menu system.
 	///
 	///	@param m is a pointer to the user provided menu
-	///	@returns \see ADDRESULT_T to indicate if the add was successful or failed
+	///	@returns ADDRESULT_T to indicate if the add was successful or failed
 	///
 	ADDRESULT_T (*Add)(CMD_T * m);
 
@@ -200,12 +200,12 @@
 	///
 	/// This function should be called periodically - fast enough not to miss user input.
 	/// This function always returns, so if not character is available for the CommandProcessor
-	/// it will return very fast. If there is a character (as detected by the \see kbhit callback),
+	/// it will return very fast. If there is a character (as detected by the kbhit callback),
 	/// then it will process that character and determine what to do. It may then execute one
 	/// of the menu functions. In this case, CPU cycles spent are based on the function 
 	/// being executed.
 	/// 
-	/// @returns \see RUNRESULT_T to indicate if the CommandProcessor should remain active or if the 
+	/// @returns RUNRESULT_T to indicate if the CommandProcessor should remain active or if the 
 	///			command that was executed is requesting the CommandProcessor to exit.
 	///
 	RUNRESULT_T (*Run)(void);
@@ -213,7 +213,7 @@
 	/// End if the function to be called when you want to gracefully end the CommandProcessor.
 	///
 	///	Calling this function causes the CommandProcessor to free any memory that was previously
-	/// allocated by the \see Init and \see Add functions.
+	/// allocated by the Init and Add functions.
 	RUNRESULT_T (*End)(void);			///< Called to shutdown the processor
 } CMDP_T;
 
@@ -228,7 +228,7 @@
 /// 	cp->Init(TRUE, TRUE, 50, _kbhit, _getch, _putch, printf);
 /// @endcode
 /// 
-/// @returns \see CMDP_T a handle to the CommandProcessor
+/// @returns CMDP_T a handle to the CommandProcessor
 ///
 #ifdef WIN32
 CMDP_T * GetCommandProcessor(void);
@@ -236,4 +236,4 @@
 extern "C" CMDP_T * GetCommandProcessor(void);
 #endif
 
-#endif // COMMANDPROCESSOR_H
\ No newline at end of file
+#endif // COMMANDPROCESSOR_H