Explain name choice for gtk_tool_item_toolbar_reconfigured.

* gtk/gtktoolitem.c: Add comment expaining name choice for
gtk_tool_item_toolbar_reconfigured.

svn path=/trunk/; revision=19362

diff --git a/ChangeLog b/ChangeLog
index 0ae3389affc7e7dff57daeca44cdaeefbf6d52e4..88f4d30ee1ff1f378c0f53637044e16e45f111a8 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2008-01-14  Mathias Hasselmann  <mathias@openismus.com>
+
+       Explain name choice for gtk_tool_item_toolbar_reconfigured.
+
+       * gtk/gtktoolitem.c: Add comment expaining name choice for
+       gtk_tool_item_toolbar_reconfigured.
+
 2008-01-14  Mathias Hasselmann  <mathias@openismus.com>
 
        Make _gtk_tool_item_toolbar_reconfigured public to allow GtkToolShell

diff --git a/gtk/gtktoolitem.c b/gtk/gtktoolitem.c
index debda87984dbe7caf4344310594f3a8071000883..d86097ae9cbf98c6bcfda93969643084e28df739 100644 (file)
--- a/gtk/gtktoolitem.c
+++ b/gtk/gtktoolitem.c
@@ -1179,6 +1179,13 @@ gtk_tool_item_set_proxy_menu_item (GtkToolItem *tool_item,
 void
 gtk_tool_item_toolbar_reconfigured (GtkToolItem *tool_item)
 {
+  /* The slightely inaccurate name "gtk_tool_item_toolbar_reconfigured" was
+   * choosen over "gtk_tool_item_tool_shell_reconfigured", since the function
+   * emits the "toolbar-reconfigured" signal, not "tool-shell-reconfigured".
+   * Its not possible to rename the signal, and emitting another name than
+   * indicated by the function name would be quite confusing. That's the
+   * price of providing stable APIs.
+   */
   g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
 
   g_signal_emit (tool_item, toolitem_signals[TOOLBAR_RECONFIGURED], 0);