Doc fixes.

[bertos.git] / mware / parser.h

diff --git a/mware/parser.h b/mware/parser.h
old mode 100755 (executable)
new mode 100644 (file)
index 34f6a14..b4e2f61
--- a/mware/parser.h
+++ b/mware/parser.h
@@ -1,7 +1,34 @@
 /**
  * \file
+ * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2003, 2006 Develer S.r.l. (http://www.develer.com/)
  * All Rights Reserved.
+ * -->
  *
  * \version $Id$
  *
@@ -12,12 +39,6 @@
  * \brief serial protocol parser and commands.
  */
 
-/*#*
- *#* $Log$
- *#* Revision 1.1  2006/06/01 12:27:39  marco
- *#* Added utilities for protocols
- *#*
- *#*/
 
 #ifndef PARSER_H
 #define PARSER_H
@@ -32,10 +53,10 @@
  */
 typedef enum
 {
-       RC_ERROR  = -1, //!< Reply with error.
-       RC_OK     = 0,  //!< No reply (ignore reply arguments).
-       RC_REPLY  = 1,   //!< Reply command arguments.
-       RC_SKIP   = 2    //!< Skip following commands
+       RC_ERROR  = -1, ///< Reply with error.
+       RC_OK     = 0,  ///< No reply (ignore reply arguments).
+       RC_REPLY  = 1,  ///< Reply command arguments.
+       RC_SKIP   = 2   ///< Skip following commands
 } ResultCode;
 
 /** union that contains parameters passed to and from commands */
@@ -57,10 +78,11 @@ typedef ResultCode (*CmdFuncPtr)(parms args_results[]);
  */
 struct CmdTemplate
 {
-       const char *name;          //!< name of command
-       const char *arg_fmt;       //!< format string for the input
-       const char *result_fmt;    //!< format string for the output
-       CmdFuncPtr func;           //!< pointer to the handler function
+       const char *name;          ///< Name of command
+       const char *arg_fmt;       ///< Format string for the input
+       const char *result_fmt;    ///< Format string for the output
+       CmdFuncPtr func;           ///< Pointer to the handler function
+       uint16_t   flags;          ///< Currently unused.
 };
 
 /**
@@ -104,7 +126,7 @@ const char* parser_rl_match(void* dummy, const char* word, int word_len);
 bool parser_process_line(const char* line);
 
 
-/*!
+/**
  * Execute a command with its arguments, and fetch its results.
  *
  * \param templ Template of the command to be executed