ekiga r5871 - in trunk: . lib/gui



Author: dsandras
Date: Sun Jan  6 18:24:49 2008
New Revision: 5871
URL: http://svn.gnome.org/viewvc/ekiga?rev=5871&view=rev

Log:
Added Doxygen-compatible docs.


Modified:
   trunk/ChangeLog
   trunk/lib/gui/codecsbox.cpp
   trunk/lib/gui/codecsbox.h

Modified: trunk/ChangeLog
==============================================================================
--- trunk/ChangeLog	(original)
+++ trunk/ChangeLog	Sun Jan  6 18:24:49 2008
@@ -1,5 +1,9 @@
 2008-01-06  Damien Sandras  <dsandras gnome org>
 
+	* lib/gui/codecsbox.h/cpp: Added Doxygen-compatible docs.
+
+2008-01-06  Damien Sandras  <dsandras gnome org>
+
 	* src/Makefile.am: Added missing files to the build.
 
 2008-01-06  Damien Sandras  <dsandras gnome org>

Modified: trunk/lib/gui/codecsbox.cpp
==============================================================================
--- trunk/lib/gui/codecsbox.cpp	(original)
+++ trunk/lib/gui/codecsbox.cpp	Sun Jan  6 18:24:49 2008
@@ -68,9 +68,8 @@
 
 
 /* Static functions */
-static void 
-codecs_box_set_codecs (CodecsBox *self,
-                          Ekiga::Call::StreamType type);
+static void codecs_box_set_codecs (CodecsBox *self,
+                                   Ekiga::Call::StreamType type);
 
 
 /* GTK+ Callbacks */
@@ -86,7 +85,7 @@
 
 /* Static functions and declarations */
 static void codecs_box_class_init (gpointer g_class,
-                                      gpointer class_data);
+                                   gpointer class_data);
 
 static void codecs_box_init (CodecsBox *);
 
@@ -94,22 +93,21 @@
 
 static void codecs_box_finalize (GObject *obj);
 
-
 static void codecs_box_get_property (GObject *obj,
-                                        guint prop_id,
-                                        GValue *value,
-                                        GParamSpec *spec);
+                                     guint prop_id,
+                                     GValue *value,
+                                     GParamSpec *spec);
 
 static void codecs_box_set_property (GObject *obj,
-                                        guint prop_id,
-                                        const GValue *value,
-                                        GParamSpec *spec);
+                                     guint prop_id,
+                                     const GValue *value,
+                                     GParamSpec *spec);
 
 
 
 static void 
 codecs_box_set_codecs (CodecsBox *self,
-                          Ekiga::Call::StreamType type)
+                       Ekiga::Call::StreamType type)
 {
   GtkTreeSelection *selection = NULL;
   GtkTreeModel *model = NULL;
@@ -133,7 +131,7 @@
 
   if (gtk_tree_selection_get_selected (selection, &model, &iter)) 
     gtk_tree_model_get (GTK_TREE_MODEL (model), &iter,
-			COLUMN_CODEC_CONFIG_NAME, &selected_codec, -1);
+                        COLUMN_CODEC_CONFIG_NAME, &selected_codec, -1);
   gtk_list_store_clear (GTK_LIST_STORE (model));
 
 
@@ -188,8 +186,8 @@
 
 static void
 codec_toggled_cb (G_GNUC_UNUSED GtkCellRendererToggle *cell,
-		  gchar *path_str,
-		  gpointer data)
+                  gchar *path_str,
+                  gpointer data)
 {
   CodecsBox *self = NULL;
 
@@ -213,7 +211,7 @@
   gtk_tree_model_get_iter (model, &iter, path);
   gtk_tree_model_get (model, &iter, COLUMN_CODEC_ACTIVE, &fixed, -1);
   gtk_list_store_set (GTK_LIST_STORE (model), &iter,
-		      COLUMN_CODEC_ACTIVE, fixed^1, -1);
+                      COLUMN_CODEC_ACTIVE, fixed^1, -1);
   gtk_tree_path_free (path);
 
   /* Update the gmconf key */
@@ -229,7 +227,7 @@
 
 static void
 codec_moved_cb (GtkWidget *widget, 
-		gpointer data)
+                gpointer data)
 { 	
   CodecsBox *self = NULL;
 
@@ -257,7 +255,7 @@
   /* Update the tree view */
   iter2 = gtk_tree_iter_copy (&iter);
   path_str = gtk_tree_model_get_string_from_iter (GTK_TREE_MODEL (model), 
-						  &iter);
+                                                  &iter);
   tree_path = gtk_tree_path_new_from_string (path_str);
   if (!strcmp ((gchar *) g_object_get_data (G_OBJECT (widget), "operation"), 
                "up"))
@@ -272,7 +270,7 @@
 
   /* Scroll to the new position */
   gtk_tree_view_scroll_to_cell (GTK_TREE_VIEW (self->priv->codecs_list), 
-				tree_path, NULL, FALSE, 0, 0);
+                                tree_path, NULL, FALSE, 0, 0);
 
   gtk_tree_path_free (tree_path);
   gtk_tree_iter_free (iter2);
@@ -336,13 +334,13 @@
 
 static void
 codecs_box_class_init (gpointer g_class,
-                          gpointer /*class_data*/)
+                       gpointer /*class_data*/)
 {
   GObjectClass *gobject_class = NULL;
   GParamSpec *spec = NULL;
 
   parent_class = (GObjectClass *) g_type_class_peek_parent (g_class);
-  
+
   gobject_class = (GObjectClass *) g_class;
   gobject_class->dispose = codecs_box_dispose;
   gobject_class->finalize = codecs_box_finalize;
@@ -411,7 +409,7 @@
   g_signal_connect (G_OBJECT (renderer), "toggled",
                     G_CALLBACK (codec_toggled_cb),
                     (gpointer) self);
-  
+
   renderer = gtk_cell_renderer_text_new ();
   column = gtk_tree_view_column_new_with_attributes (NULL,
                                                      renderer,
@@ -508,9 +506,9 @@
 
 static void
 codecs_box_get_property (GObject *obj,
-                            guint prop_id,
-                            GValue *value,
-                            GParamSpec *spec)
+                         guint prop_id,
+                         GValue *value,
+                         GParamSpec *spec)
 {
   CodecsBox *self = NULL;
 
@@ -531,9 +529,9 @@
 
 static void
 codecs_box_set_property (GObject *obj,
-                            guint prop_id,
-                            const GValue *value,
-                            GParamSpec *spec)
+                         guint prop_id,
+                         const GValue *value,
+                         GParamSpec *spec)
 {
   CodecsBox *self = NULL;
 
@@ -559,30 +557,30 @@
 codecs_box_get_type (void)
 {
   static GType codecs_box_type = 0;
-  
+
   if (codecs_box_type == 0)
-  {
-    static const GTypeInfo codecs_box_info =
     {
-      sizeof (CodecsBoxClass),
-      NULL,
-      NULL,
-      (GClassInitFunc) codecs_box_class_init,
-      NULL,
-      NULL,
-      sizeof (CodecsBox),
-      0,
-      (GInstanceInitFunc) codecs_box_init,
-      NULL
-    };
-    
-    codecs_box_type =
-      g_type_register_static (GTK_TYPE_HBOX,
-			      "CodecsBox",
-			      &codecs_box_info,
-			      (GTypeFlags) 0);
-  }
-  
+      static const GTypeInfo codecs_box_info =
+        {
+          sizeof (CodecsBoxClass),
+          NULL,
+          NULL,
+          (GClassInitFunc) codecs_box_class_init,
+          NULL,
+          NULL,
+          sizeof (CodecsBox),
+          0,
+          (GInstanceInitFunc) codecs_box_init,
+          NULL
+        };
+
+      codecs_box_type =
+        g_type_register_static (GTK_TYPE_HBOX,
+                                "CodecsBox",
+                                &codecs_box_info,
+                                (GTypeFlags) 0);
+    }
+
   return codecs_box_type;
 }
 

Modified: trunk/lib/gui/codecsbox.h
==============================================================================
--- trunk/lib/gui/codecsbox.h	(original)
+++ trunk/lib/gui/codecsbox.h	Sun Jan  6 18:24:49 2008
@@ -48,6 +48,15 @@
 
 #include "call.h"
 
+
+/** This implements a CodecsBox for the Ekiga Engine.
+ * The codecs list is loaded from the GmConf configuration engine, 
+ * using the /apps/ekiga/codecs/audio/list or /apps/ekiga/codecs/video/list
+ * following the type of codecs. The key is supposed to contain
+ * all codecs supported by the Engine. The key value is formated so that it
+ * respects the output of an Ekiga::CodecDescription.
+ */
+
 G_BEGIN_DECLS
 
 #define CODECS_BOX_TYPE (codecs_box_get_type ())
@@ -74,23 +83,17 @@
   GtkHBoxClass parent_class;
 };
 
+GType codecs_box_get_type (void);
 
-/* The functions */
 
-/* DESCRIPTION  :  /
- * BEHAVIOR     :  Returns the GType for the CodecsBox.
- * PRE          :  /
+/** Create a new CodecsBox for Ekiga::Call::Audio codecs.
  */
-GType codecs_box_get_type (void);
+GtkWidget *codecs_box_new ();
 
 
-/* DESCRIPTION  :  /
- * BEHAVIOR     :  Creates a new CodecsBox. If activatable_codecs is TRUE,
- *                 codecs can be enabled or disabled. conf_key is the key
- *                 where to store results.
- * PRE          :  A valid GMConf key.
+/** Create a new CodecsBox.
+ * @param type is a valid Ekiga::Call::StreamType (Audio or Video supported).
  */
-GtkWidget *codecs_box_new ();
 GtkWidget *codecs_box_new_with_type (Ekiga::Call::StreamType type);
 
 G_END_DECLS



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]