gimp r26526 - in branches/soc-2008-tagging: . app/core app/widgets

[aurisj svn gnome org]

Author: aurisj
Date: Tue Aug 12 20:33:29 2008
New Revision: 26526
URL: http://svn.gnome.org/viewvc/gimp?rev=26526&view=rev

Log:
2008-08-12  Aurimas JuÅka  <aurisj svn gnome org>

	* app/core/gimpfilteredcontainer.[ch]
	* app/core/gimptag.[ch]
	* app/widgets/gimptagentry.c
	* app/widgets/gimptagpopup.h: improvements and fixes for documentation
	reference comments.



Modified:
   branches/soc-2008-tagging/ChangeLog
   branches/soc-2008-tagging/app/core/gimpfilteredcontainer.c
   branches/soc-2008-tagging/app/core/gimpfilteredcontainer.h
   branches/soc-2008-tagging/app/core/gimptag.c
   branches/soc-2008-tagging/app/core/gimptag.h
   branches/soc-2008-tagging/app/widgets/gimptagentry.c
   branches/soc-2008-tagging/app/widgets/gimptagpopup.h

Modified: branches/soc-2008-tagging/app/core/gimpfilteredcontainer.c
==============================================================================
--- branches/soc-2008-tagging/app/core/gimpfilteredcontainer.c	(original)
+++ branches/soc-2008-tagging/app/core/gimpfilteredcontainer.c	Tue Aug 12 20:33:29 2008
@@ -149,10 +149,10 @@
  * gimp_filtered_container_new:
  * @src_container: container to be filtered.
  *
- * Creates a new #GimpFilteredContainer object. Since #GimpFilteredContainer is a
- * #GimpContainer implementation, it holds GimpObjects. It filters @src_container for objects
- * containing all of the filtering tags. Syncronization with @src_container data is performed
- * automatically.
+ * Creates a new #GimpFilteredContainer object which creates filtered
+ * data view of #GimpTagged objects. It filters @src_container for objects
+ * containing all of the filtering tags. Syncronization with @src_container
+ * data is performed automatically.
  *
  * Return value: a new #GimpFilteredContainer object.
  **/

Modified: branches/soc-2008-tagging/app/core/gimpfilteredcontainer.h
==============================================================================
--- branches/soc-2008-tagging/app/core/gimpfilteredcontainer.h	(original)
+++ branches/soc-2008-tagging/app/core/gimpfilteredcontainer.h	Tue Aug 12 20:33:29 2008
@@ -58,10 +58,10 @@
 
 GimpContainer * gimp_filtered_container_new           (GimpContainer           *src_container);
 
-void            gimp_filtered_container_set_filter    (GimpFilteredContainer   *container,
+void            gimp_filtered_container_set_filter    (GimpFilteredContainer   *filtered_container,
                                                        GList                   *tags);
 
-const GList   * gimp_filtered_container_get_filter    (GimpFilteredContainer   *container);
+const GList   * gimp_filtered_container_get_filter    (GimpFilteredContainer   *filtered_container);
 
 gint            gimp_filtered_container_get_tag_count (GimpFilteredContainer   *container);
 

Modified: branches/soc-2008-tagging/app/core/gimptag.c
==============================================================================
--- branches/soc-2008-tagging/app/core/gimptag.c	(original)
+++ branches/soc-2008-tagging/app/core/gimptag.c	Tue Aug 12 20:33:29 2008
@@ -48,8 +48,7 @@
  * gimp_tag_new:
  * @tag_string: a tag name.
  *
- * Given tag name does not need to be valid. If it is not valid, an attempt
- * will be made to fix it.
+ * If given tag name is not valid, an attempt will be made to fix it.
  *
  * Return value: a new #GimpTag object, or NULL if tag string is invalid and
  * cannot be fixed.
@@ -141,6 +140,8 @@
  * gimp_tag_get_name:
  * @tag: a gimp tag.
  *
+ * Retrieve name of the tag.
+ *
  * Return value: name of tag.
  **/
 const gchar *
@@ -388,25 +389,25 @@
 
 /**
  * gimp_tag_string_make_valid:
- * @string: a text string.
+ * @tag_string: a text string.
  *
- * Tries to create a valid tag string from given @string.
+ * Tries to create a valid tag string from given @tag_string.
  *
- * Return value: a newly allocated tag string in case given @string was valid
- * or could be fixed, otherwise NULL. Allocated value should be freed using
- * g_free().
+ * Return value: a newly allocated tag string in case given @tag_string was
+ * valid or could be fixed, otherwise NULL. Allocated value should be freed
+ * using g_free().
  **/
 gchar *
-gimp_tag_string_make_valid (const gchar      *string)
+gimp_tag_string_make_valid (const gchar      *tag_string)
 {
   gchar        *tag;
-  GString      *tag_string;
+  GString      *buffer;
   gchar        *tag_cursor;
   gunichar      c;
 
-  g_return_val_if_fail (string, NULL);
+  g_return_val_if_fail (tag_string, NULL);
 
-  tag = g_utf8_normalize (string, -1, G_NORMALIZE_ALL);
+  tag = g_utf8_normalize (tag_string, -1, G_NORMALIZE_ALL);
   if (! tag)
     {
       return NULL;
@@ -419,7 +420,7 @@
       return NULL;
     }
 
-  tag_string = g_string_new ("");
+  buffer = g_string_new ("");
   tag_cursor = tag;
   if (g_str_has_prefix (tag_cursor, GIMP_TAG_INTERNAL_PREFIX))
     {
@@ -432,12 +433,12 @@
       if (g_unichar_isprint (c)
           && ! g_unichar_is_terminal_punctuation (c))
         {
-          g_string_append_unichar (tag_string, c);
+          g_string_append_unichar (buffer, c);
         }
     } while (c);
 
   g_free (tag);
-  tag = g_string_free (tag_string, FALSE);
+  tag = g_string_free (buffer, FALSE);
   tag = g_strstrip (tag);
 
   if (! *tag)

Modified: branches/soc-2008-tagging/app/core/gimptag.h
==============================================================================
--- branches/soc-2008-tagging/app/core/gimptag.h	(original)
+++ branches/soc-2008-tagging/app/core/gimptag.h	Tue Aug 12 20:33:29 2008
@@ -62,7 +62,7 @@
 gint            gimp_tag_compare_func          (const void     *p1,
                                                 const void     *p2);
 gint            gimp_tag_compare_with_string   (GimpTag        *tag,
-                                                const gchar    *string);
+                                                const gchar    *tag_string);
 
 gchar         * gimp_tag_string_make_valid     (const gchar    *tag_string);
 

Modified: branches/soc-2008-tagging/app/widgets/gimptagentry.c
==============================================================================
--- branches/soc-2008-tagging/app/widgets/gimptagentry.c	(original)
+++ branches/soc-2008-tagging/app/widgets/gimptagentry.c	Tue Aug 12 20:33:29 2008
@@ -847,7 +847,7 @@
 
 /**
  * gimp_tag_entry_set_selected_items:
- * @entry:      a #GimpTagEntry widget.
+ * @tag_entry:  a #GimpTagEntry widget.
  * @items:      a list of #GimpTagged objects.
  *
  * Set list of currently selected #GimpTagged objects. Only selected and
@@ -855,26 +855,26 @@
  * operating in tag assignment mode.
  **/
 void
-gimp_tag_entry_set_selected_items (GimpTagEntry            *entry,
+gimp_tag_entry_set_selected_items (GimpTagEntry            *tag_entry,
                                    GList                   *items)
 {
   GList        *iterator;
 
-  g_return_if_fail (GIMP_IS_TAG_ENTRY (entry));
+  g_return_if_fail (GIMP_IS_TAG_ENTRY (tag_entry));
 
-  if (entry->selected_items)
+  if (tag_entry->selected_items)
     {
-      g_list_free (entry->selected_items);
-      entry->selected_items = NULL;
+      g_list_free (tag_entry->selected_items);
+      tag_entry->selected_items = NULL;
     }
 
-  entry->selected_items = g_list_copy (items);
+  tag_entry->selected_items = g_list_copy (items);
 
-  iterator = entry->selected_items;
+  iterator = tag_entry->selected_items;
   while (iterator)
     {
       if (gimp_tagged_get_tags (GIMP_TAGGED (iterator->data))
-          && gimp_container_have (GIMP_CONTAINER (entry->filtered_container),
+          && gimp_container_have (GIMP_CONTAINER (tag_entry->filtered_container),
                                   GIMP_OBJECT(iterator->data)))
         {
           break;
@@ -883,19 +883,19 @@
       iterator = g_list_next (iterator);
     }
 
-  if (entry->mode == GIMP_TAG_ENTRY_MODE_ASSIGN)
+  if (tag_entry->mode == GIMP_TAG_ENTRY_MODE_ASSIGN)
     {
       if (iterator)
         {
-          gimp_tag_entry_load_selection (entry, TRUE);
-          gimp_tag_entry_toggle_desc (entry, FALSE);
+          gimp_tag_entry_load_selection (tag_entry, TRUE);
+          gimp_tag_entry_toggle_desc (tag_entry, FALSE);
         }
       else
         {
-          entry->internal_operation++;
-          gtk_editable_delete_text (GTK_EDITABLE (entry), 0, -1);
-          entry->internal_operation--;
-          gimp_tag_entry_toggle_desc (entry, TRUE);
+          tag_entry->internal_operation++;
+          gtk_editable_delete_text (GTK_EDITABLE (tag_entry), 0, -1);
+          tag_entry->internal_operation--;
+          gimp_tag_entry_toggle_desc (tag_entry, TRUE);
         }
     }
 }
@@ -1664,6 +1664,14 @@
   return TRUE;
 }
 
+/**
+ * gimp_tag_entry_get_separator:
+ *
+ * Tag separator is a single Unicode terminal punctuation
+ * character.
+ *
+ * Return value: returns locale dependent tag separator.
+ **/
 const gchar *
 gimp_tag_entry_get_separator  (void)
 {

Modified: branches/soc-2008-tagging/app/widgets/gimptagpopup.h
==============================================================================
--- branches/soc-2008-tagging/app/widgets/gimptagpopup.h	(original)
+++ branches/soc-2008-tagging/app/widgets/gimptagpopup.h	Tue Aug 12 20:33:29 2008
@@ -74,6 +74,6 @@
 
 GType       gimp_tag_popup_get_type       (void) G_GNUC_CONST;
 
-GtkWidget * gimp_tag_popup_new            (GimpComboTagEntry             *tag_entry);
+GtkWidget * gimp_tag_popup_new            (GimpComboTagEntry             *combo_entry);
 
 #endif  /*  __GIMP_TAG_POPUP_H__  */