Modified in accordance to coding guidelines for header and C files.
[glsdk/dual-decode.git] / include / common.h
index a1f50ddfe022889a2ef6a577d47847c38e6f66f1..c05879971c0272daa54abea8114a8d1f9c16392e 100644 (file)
  *\r
  * @brief              Declares global variables and utility functions\r
  */\r
+#ifndef __COMMON_H__\r
+#define __COMMON_H__\r
+\r
 #include <linux/limits.h>\r
 #include <glib.h>\r
 \r
-#ifndef __COMMON_H__\r
-#define __COMMON_H__\r
+/**\r
+ *Extern variables which flags passed as options.\r
+ */\r
+\r
+/**\r
+ * @brief     The decode mode of the appplication : single, dual or none.\r
+ */\r
+extern gint decodeMode; \r
+\r
+/**\r
+ * @brief     Array to store filenames of the media files\r
+ */\r
+\r
+extern gchar *filename[];\r
+\r
+/**\r
+ * @brief   Stores if version of the application is asked on the command line. \r
+ */\r
+\r
+extern gboolean version;\r
+\r
+/**\r
+ * @brief    Video sink to be used.\r
+ */\r
+\r
+extern gchar *sink;\r
+\r
+/**\r
+ * @brief     Variable for processing the filenames passed as command line \r
+ *            arguments.\r
+ */\r
 \r
-/*Error codes*/\r
+extern gchar **files;\r
+/**\r
+ * @brief     Version of the application.\r
+ */\r
+\r
+extern const gchar *version_text;\r
+\r
+\r
+/**\r
+ *Error codes\r
+ */\r
 #define ERR_SUCCESS 0\r
 #define ERR_XNOTFOUND -1\r
 #define ERR_INVALIDPARAM -2\r
 #define ERR_OPTIONPARSE -4\r
 #define ERR_BUG -5\r
 \r
-/*Dual decode, maximum pipelines = 2*/\r
+/**\r
+ *Dual decode, maximum pipelines = 2\r
+ */\r
 #define NUM_MAX_FILES 2\r
 #define PATH_MAX_LEN (PATH_MAX + strlen("file://"))\r
 \r
-/*Decode mode*/\r
 \r
-/*\r
+/**\r
+ * Decode mode of the application.\r
  * DECODE_MODE_NONE only applicable if \r
  * application is started without any \r
  * filename argument. This flag is used only\r
 #define DECODE_MODE_SINGLE 1 \r
 #define DECODE_MODE_DUAL 2\r
 \r
+/**\r
+ * Initial position of the media file\r
+ */\r
 #define SEEK_START 0\r
-/*Extern variables which flags passed as options*/\r
-extern gint decodeMode; \r
-extern gchar *filename[];\r
-extern gboolean version;\r
-extern gchar *sink;\r
-extern gchar **files;\r
-extern const gchar *version_text;\r
 \r
-char *realpath(const char *path, char *resolved_path);\r
 #endif /*__COMMON_H__*/\r