some comments
authorThomas Thurman <tthurman@gnome.org>
Sun, 30 Aug 2009 21:22:38 +0000 (17:22 -0400)
committerThomas Thurman <tthurman@gnome.org>
Sun, 30 Aug 2009 21:22:38 +0000 (17:22 -0400)
belltower.c

index 920e5e8..b5ef2a3 100644 (file)
@@ -834,8 +834,18 @@ free_tower_list (GSList *list)
   g_slist_free (list);
 }
 
+/**
+ * Displays a list of towers for the user to choose from.
+ * When one is chosen, we go to the display page for that tower.
+ * If there are none, this will tell the user there were none.
+ * If there is only one, we go straight to its display page.
+ *
+ * \param list       a GSList of FoundTower objects.
+ * \param list_name  the title for the dialogue.
+ */
 static void
-show_towers_from_list (GSList *list)
+show_towers_from_list (GSList *list,
+                      gchar *list_name)
 {
   GtkWidget *dialog;
   GtkWidget *selector;
@@ -867,6 +877,7 @@ show_towers_from_list (GSList *list)
 
   dialog = hildon_picker_dialog_new (GTK_WINDOW (window));
   selector = hildon_touch_selector_new_text ();
+  gtk_window_set_title (GTK_WINDOW (dialog), list_name);
 
   for (cursor=list; cursor; cursor=cursor->next)
     {
@@ -1030,6 +1041,14 @@ get_countries_with_many (GHashTable *source,
 #define COUNTRIES_WITH_MANY "Countries with many belltowers"
 #define COUNTRIES_WITH_FEW "Countries with few belltowers"
 
+/**
+ * Displays a list of areas of the world with many (or few)
+ * belltowers.  If you ask for the areas with many, it include
+ * a link to the areas with few.
+ *
+ * \param countries_with_many  True to list countries with many;
+ *                             false to list countries with few.
+ */
 static void
 towers_by_area_with_many (gboolean countries_with_many)
 {