Author: remi
Date: 2008-12-01 10:45:43 +0100 (Mon, 01 Dec 2008)
New Revision: 2950
Modified:
software_suite_v2/tuxware/tuxdriver/trunk/src/tux_error.c
software_suite_v2/tuxware/tuxdriver/trunk/src/tux_error.h
Log:
* added comments and doxygen.
Modified: software_suite_v2/tuxware/tuxdriver/trunk/src/tux_error.c
===================================================================
--- software_suite_v2/tuxware/tuxdriver/trunk/src/tux_error.c 2008-12-01
09:38:36 UTC (rev 2949)
+++ software_suite_v2/tuxware/tuxdriver/trunk/src/tux_error.c 2008-12-01
09:45:43 UTC (rev 2950)
@@ -18,11 +18,20 @@
* 02111-1307, USA.
*/
+/**
+ * \file tux_error.c
+ * \brief Error functions.
+ * \author [EMAIL PROTECTED]
+ * \ingroup error
+ */
+
#include "tux_misc.h"
#include "tux_error.h"
/**
- *
+ * \brief Get an explicite message from an error code.
+ * \param error_code Error code.
+ * \return The explicite message.
*/
LIBLOCAL const char *
tux_error_strerror(TuxDrvError error_code)
Modified: software_suite_v2/tuxware/tuxdriver/trunk/src/tux_error.h
===================================================================
--- software_suite_v2/tuxware/tuxdriver/trunk/src/tux_error.h 2008-12-01
09:38:36 UTC (rev 2949)
+++ software_suite_v2/tuxware/tuxdriver/trunk/src/tux_error.h 2008-12-01
09:45:43 UTC (rev 2950)
@@ -18,25 +18,35 @@
* 02111-1307, USA.
*/
+/**
+ * \file tux_error.h
+ * \brief Error header.
+ * \author [EMAIL PROTECTED]
+ * \ingroup error
+ */
+
#ifndef _TUX_ERROR_H_
#define _TUX_ERROR_H_
+/** \brief Errors code begin index */
#define TUX_ERROR_BEGIN 256
+/** \brief TuxDrvError type */
typedef int TuxDrvError;
+/** \brief Error codes enumeration */
typedef enum
{
- E_TUXDRV_NOERROR = 0,
- E_TUXDRV_PARSERISDISABLED = TUX_ERROR_BEGIN,
- E_TUXDRV_INVALIDCOMMAND,
- E_TUXDRV_STACKOVERFLOW,
- E_TUXDRV_FILEERROR,
- E_TUXDRV_BADWAVFILE,
- E_TUXDRV_INVALIDIDENTIFIER,
- E_TUXDRV_INVALIDNAME,
- E_TUXDRV_INVALIDPARAMETER,
- E_TUXDRV_BUSY,
- E_TUXDRV_WAVSIZEEXCEDED,
+ E_TUXDRV_NOERROR = 0, /**< No error */
+ E_TUXDRV_PARSERISDISABLED = TUX_ERROR_BEGIN, /**< The parser is disabled*/
+ E_TUXDRV_INVALIDCOMMAND, /**< The command is invalid */
+ E_TUXDRV_STACKOVERFLOW, /**< Command stack overflow */
+ E_TUXDRV_FILEERROR, /**< File IO error */
+ E_TUXDRV_BADWAVFILE, /**< Bad wave file */
+ E_TUXDRV_INVALIDIDENTIFIER, /**< Invalid status identifier */
+ E_TUXDRV_INVALIDNAME, /**< Invalid status name */
+ E_TUXDRV_INVALIDPARAMETER, /**< Invalid command parameter */
+ E_TUXDRV_BUSY, /**< Tuxdriver is busy */
+ E_TUXDRV_WAVSIZEEXCEDED, /**< Wave size exceded (for sound flash) */
} tux_drv_error_t;
extern const char *tux_error_strerror(TuxDrvError error_code);
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Tux-droid-svn mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/tux-droid-svn
