[gedit/wip/merge-encoding-settings: 15/15] EncodingsComboBox: code clean-up, improve doc

[Sébastien Wilmet <swilmet src gnome org>]

commit e4c736b4faafadea3382f9b075d80d24112dc17c
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sun Aug 10 23:27:23 2014 +0200

    EncodingsComboBox: code clean-up, improve doc

 gedit/gedit-encodings-combo-box.c |   34 ++++++++++++++++++++--------------
 gedit/gedit-encodings-combo-box.h |    9 +++------
 2 files changed, 23 insertions(+), 20 deletions(-)
---
diff --git a/gedit/gedit-encodings-combo-box.c b/gedit/gedit-encodings-combo-box.c
index ffa91c2..5143d45 100644
--- a/gedit/gedit-encodings-combo-box.c
+++ b/gedit/gedit-encodings-combo-box.c
@@ -1,4 +1,3 @@
-/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
 /*
  * gedit-encodings-combo-box.c
  * This file is part of gedit
@@ -23,16 +22,14 @@
 #include <config.h>
 #endif
 
+#include "gedit-encodings-combo-box.h"
+
 #include <glib/gi18n.h>
-#include <gtksourceview/gtksource.h>
 
-#include "gedit-encodings-combo-box.h"
 #include "gedit-encodings-dialog.h"
 #include "gedit-settings.h"
 #include "gedit-utils.h"
 
-#define ENCODING_KEY "Enconding"
-
 struct _GeditEncodingsComboBoxPrivate
 {
        GSettings *enc_settings;
@@ -53,14 +50,12 @@ enum
        N_COLUMNS
 };
 
-/* Properties */
 enum
 {
        PROP_0,
        PROP_SAVE_MODE
 };
 
-
 G_DEFINE_TYPE_WITH_PRIVATE (GeditEncodingsComboBox, gedit_encodings_combo_box, GTK_TYPE_COMBO_BOX)
 
 static void      update_menu           (GeditEncodingsComboBox       *combo_box);
@@ -150,6 +145,16 @@ gedit_encodings_combo_box_class_init (GeditEncodingsComboBoxClass *klass)
        object_class->dispose = gedit_encodings_combo_box_dispose;
        object_class->constructed = gedit_encodings_combo_box_constructed;
 
+       /**
+        * GeditEncodingsComboBox:save-mode:
+        *
+        * Whether the combo box should be used for saving a content. If
+        * %FALSE, the combo box is used for loading a content (e.g. a file)
+        * and the row "Automatically Detected" is added.
+        */
+       /* TODO It'd be clearer if "save-mode" is renamed as "mode" with an
+        * enum: loading, saving.
+        */
        g_object_class_install_property (object_class,
                                         PROP_SAVE_MODE,
                                         g_param_spec_boolean ("save-mode",
@@ -285,6 +290,7 @@ update_menu (GeditEncodingsComboBox *menu)
                                    COLUMN_ADD, FALSE,
                                    -1);
 
+               /* separator */
                gtk_list_store_append (store, &iter);
                gtk_list_store_set (store, &iter,
                                    COLUMN_NAME, "",
@@ -312,8 +318,8 @@ update_menu (GeditEncodingsComboBox *menu)
 
        g_free (str);
 
-       if ((utf8_encoding != current_encoding) &&
-           (current_encoding != NULL))
+       if (utf8_encoding != current_encoding &&
+           current_encoding != NULL)
        {
                str = g_strdup_printf (_("Current Locale (%s)"),
                                       gtk_source_encoding_get_charset (current_encoding));
@@ -338,9 +344,9 @@ update_menu (GeditEncodingsComboBox *menu)
        {
                const GtkSourceEncoding *enc = l->data;
 
-               if ((enc != current_encoding) &&
-                   (enc != utf8_encoding) &&
-                   (enc != NULL))
+               if (enc != current_encoding &&
+                   enc != utf8_encoding &&
+                   enc != NULL)
                {
                        str = gtk_source_encoding_to_string (enc);
 
@@ -357,8 +363,8 @@ update_menu (GeditEncodingsComboBox *menu)
 
        g_slist_free (encodings);
 
-       gtk_list_store_append (store, &iter);
        /* separator */
+       gtk_list_store_append (store, &iter);
        gtk_list_store_set (store, &iter,
                            COLUMN_NAME, "",
                            COLUMN_ENCODING, NULL,
@@ -437,7 +443,7 @@ gedit_encodings_combo_box_get_selected_encoding (GeditEncodingsComboBox *menu)
  * gedit_encodings_combo_box_set_selected_encoding:
  * @menu:
  * @encoding: (allow-none):
- **/
+ */
 void
 gedit_encodings_combo_box_set_selected_encoding (GeditEncodingsComboBox  *menu,
                                                 const GtkSourceEncoding *encoding)
diff --git a/gedit/gedit-encodings-combo-box.h b/gedit/gedit-encodings-combo-box.h
index 27318fb..f26db11 100644
--- a/gedit/gedit-encodings-combo-box.h
+++ b/gedit/gedit-encodings-combo-box.h
@@ -1,4 +1,3 @@
-/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
 /*
  * gedit-encodings-combo-box.h
  * This file is part of gedit
@@ -22,7 +21,7 @@
 #ifndef __GEDIT_ENCODINGS_COMBO_BOX_H__
 #define __GEDIT_ENCODINGS_COMBO_BOX_H__
 
-#include <gtk/gtk.h>
+#include <gtksourceview/gtksource.h>
 
 G_BEGIN_DECLS
 
@@ -33,10 +32,8 @@ G_BEGIN_DECLS
 #define GEDIT_IS_ENCODINGS_COMBO_BOX_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), 
GEDIT_TYPE_ENCODINGS_COMBO_BOX))
 #define GEDIT_ENCODINGS_COMBO_BOX_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), 
GEDIT_TYPE_ENCODINGS_COMBO_BOX, GeditEncodingsComboBoxClass))
 
-
-typedef struct _GeditEncodingsComboBox         GeditEncodingsComboBox;
-typedef struct _GeditEncodingsComboBoxClass    GeditEncodingsComboBoxClass;
-
+typedef struct _GeditEncodingsComboBox         GeditEncodingsComboBox;
+typedef struct _GeditEncodingsComboBoxClass    GeditEncodingsComboBoxClass;
 typedef struct _GeditEncodingsComboBoxPrivate  GeditEncodingsComboBoxPrivate;
 
 struct _GeditEncodingsComboBox