From: Owen Taylor <otaylor@redhat.com>
Date: Mon, 1 Mar 2004 14:20:30 +0000 (+0000)
Subject: Clarify doc comment.
X-Git-Url: http://git.openbox.org/?a=commitdiff_plain;h=3e8b3a13f5ff3eaff583d98ca641170ba1422fce;p=dana%2Fcg-glib.git

Clarify doc comment.

Mon Mar  1 09:17:32 2004  Owen Taylor  <otaylor@redhat.com>

        * glib/gmain.c (g_main_depth): Clarify doc comment.
---

diff --git a/ChangeLog b/ChangeLog
index f588b635..9554bb18 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+Mon Mar  1 09:17:32 2004  Owen Taylor  <otaylor@redhat.com>
+
+	* glib/gmain.c (g_main_depth): Clarify doc comment.
+
 2004-03-01  Sebastian Wilhelmi  <seppi@seppi.de>
 
 	* glib/gatomic.c: Define g_atomic_(int|pointer)_get only for
diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index f588b635..9554bb18 100644
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,7 @@
+Mon Mar  1 09:17:32 2004  Owen Taylor  <otaylor@redhat.com>
+
+	* glib/gmain.c (g_main_depth): Clarify doc comment.
+
 2004-03-01  Sebastian Wilhelmi  <seppi@seppi.de>
 
 	* glib/gatomic.c: Define g_atomic_(int|pointer)_get only for
diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index f588b635..9554bb18 100644
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -1,3 +1,7 @@
+Mon Mar  1 09:17:32 2004  Owen Taylor  <otaylor@redhat.com>
+
+	* glib/gmain.c (g_main_depth): Clarify doc comment.
+
 2004-03-01  Sebastian Wilhelmi  <seppi@seppi.de>
 
 	* glib/gatomic.c: Define g_atomic_(int|pointer)_get only for
diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4
index f588b635..9554bb18 100644
--- a/ChangeLog.pre-2-4
+++ b/ChangeLog.pre-2-4
@@ -1,3 +1,7 @@
+Mon Mar  1 09:17:32 2004  Owen Taylor  <otaylor@redhat.com>
+
+	* glib/gmain.c (g_main_depth): Clarify doc comment.
+
 2004-03-01  Sebastian Wilhelmi  <seppi@seppi.de>
 
 	* glib/gatomic.c: Define g_atomic_(int|pointer)_get only for
diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index f588b635..9554bb18 100644
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,3 +1,7 @@
+Mon Mar  1 09:17:32 2004  Owen Taylor  <otaylor@redhat.com>
+
+	* glib/gmain.c (g_main_depth): Clarify doc comment.
+
 2004-03-01  Sebastian Wilhelmi  <seppi@seppi.de>
 
 	* glib/gatomic.c: Define g_atomic_(int|pointer)_get only for
diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index f588b635..9554bb18 100644
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,3 +1,7 @@
+Mon Mar  1 09:17:32 2004  Owen Taylor  <otaylor@redhat.com>
+
+	* glib/gmain.c (g_main_depth): Clarify doc comment.
+
 2004-03-01  Sebastian Wilhelmi  <seppi@seppi.de>
 
 	* glib/gatomic.c: Define g_atomic_(int|pointer)_get only for
diff --git a/glib/gmain.c b/glib/gmain.c
index a0ad7646..832abc42 100644
--- a/glib/gmain.c
+++ b/glib/gmain.c
@@ -1824,13 +1824,10 @@ get_depth_pointer (void)
  * problems with reentrancy. For instance, while waiting for data
  * to be received from the network in response to a menu item,
  * the menu item might be selected again. It might seem that
- * one could write:
- *
- *   if (g_main_depth () > 1)
- *     return; 
- *
- * This should be avoided since the user then sees selecting the
- * menu item do nothing. Furthermore, you'll find yourself adding
+ * one could make the menu item's callback return immediately
+ * and do nothing if g_main_depth() returns a value greater than 1.
+ * However, this should be avoided since the user then sees selecting
+ * the menu item do nothing. Furthermore, you'll find yourself adding
  * these checks all over your code, since there are doubtless many,
  * many things that the user could do. Instead, you can use the
  * following techniques: