summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.van.berkom@gmail.com>2010-10-06 17:00:43 +0900
committerTristan Van Berkom <tristan.van.berkom@gmail.com>2010-10-06 17:00:43 +0900
commite1b00b52d27791221133cd21ce6db9a2de032b23 (patch)
treedc2c9d81896fa87c7c63ea1ef7f0859904947b3f
parent22e9fcf6db31f2a575530a275fc1461d1c0be678 (diff)
downloadgtk+-e1b00b52d27791221133cd21ce6db9a2de032b23.tar.gz
Enhanced documentation description for GtkWrapBox (text by Murray Cumming).
-rw-r--r--gtk/gtkwrapbox.c15
1 files changed, 12 insertions, 3 deletions
diff --git a/gtk/gtkwrapbox.c b/gtk/gtkwrapbox.c
index ed751f65b2..4bcf69f75b 100644
--- a/gtk/gtkwrapbox.c
+++ b/gtk/gtkwrapbox.c
@@ -23,12 +23,21 @@
/**
* SECTION:gtkwrapbox
- * @Short_Description: A container that wraps its children;
+ * @Short_Description: A container that wraps its children
* @Title: GtkWrapBox
*
- * #GtkWrapBox allocates space for an ordered list of children
- * by wrapping them over in the box's orentation.
+ * #GtkWrapBox positions child widgets in sequence according to its
+ * orientation. For instance, with the horizontal orientation, the widgets
+ * will be arranged from left to right, starting a new row under the
+ * previous row when necessary. Reducing the width in this case will
+ * require more rows, so a larger height will be requested.
*
+ * Likewise, with the vertical orientation, the widgets will be arranged
+ * from top to bottom, starting a new column to the right when necessary.
+ * Reducing the height will require more columns, so a larger width will be
+ * requested.
+ *
+ * Unlike a GtkTable, the child widgets do not need to align in a grid.
*/
#include "config.h"