[libwnck/wip/xfce-4.10-fixes] doc: Improve documentation for new API



commit aa20aad5ea7c55d5f0cd8897300f7b8bb645f64d
Author: Vincent Untz <vuntz gnome org>
Date:   Fri Mar 2 17:22:13 2012 +0100

    doc: Improve documentation for new API

 doc/libwnck-sections.txt |    2 ++
 doc/tmpl/pager.sgml      |   18 ++++++++++++++++++
 libwnck/pager.c          |    2 ++
 libwnck/pager.h          |   18 ++++++++++--------
 4 files changed, 32 insertions(+), 8 deletions(-)
---
diff --git a/doc/libwnck-sections.txt b/doc/libwnck-sections.txt
index f72fa59..f5f66d9 100644
--- a/doc/libwnck-sections.txt
+++ b/doc/libwnck-sections.txt
@@ -242,6 +242,8 @@ wnck_pager_new
 wnck_pager_set_screen
 wnck_pager_set_orientation
 wnck_pager_set_n_rows
+WnckPagerLayoutPolicy
+wnck_pager_set_layout_policy
 WnckPagerDisplayMode
 wnck_pager_set_display_mode
 wnck_pager_set_show_all
diff --git a/doc/tmpl/pager.sgml b/doc/tmpl/pager.sgml
index c709812..ce6f666 100644
--- a/doc/tmpl/pager.sgml
+++ b/doc/tmpl/pager.sgml
@@ -64,6 +64,24 @@ WnckPager
 @Returns: 
 
 
+<!-- ##### ENUM WnckPagerLayoutPolicy ##### -->
+<para>
+
+</para>
+
+ WNCK_PAGER_LAYOUT_POLICY_AUTOMATIC: 
+ WNCK_PAGER_LAYOUT_POLICY_WIDTH_FOR_HEIGHT: 
+ WNCK_PAGER_LAYOUT_POLICY_HEIGHT_FOR_WIDTH: 
+
+<!-- ##### FUNCTION wnck_pager_set_layout_policy ##### -->
+<para>
+
+</para>
+
+ pager: 
+ policy: 
+
+
 <!-- ##### ENUM WnckPagerDisplayMode ##### -->
 <para>
 
diff --git a/libwnck/pager.c b/libwnck/pager.c
index 6d8f54e..2fb7f9d 100644
--- a/libwnck/pager.c
+++ b/libwnck/pager.c
@@ -2212,6 +2212,8 @@ wnck_pager_set_display_mode (WnckPager            *pager,
  * @policy: a layout policy.
  *
  * Sets the layout policy for @pager to @policy.
+ *
+ * Since: 2.32
  */
 void
 wnck_pager_set_layout_policy (WnckPager             *pager,
diff --git a/libwnck/pager.h b/libwnck/pager.h
index e8add1a..523efa3 100644
--- a/libwnck/pager.h
+++ b/libwnck/pager.h
@@ -80,17 +80,19 @@ typedef enum {
 
 /**
  * WnckPagerLayoutPolicy:
- * @WNCK_PAGER_LAYOUT_POLICY_AUTOMATIC: the #WnckPager is resize policy is
- * "height for width" for in vertical orientation, or "width for height"
- * in horizontal one. This is a default behavior of libwnck <= 2.30.7
- * @WNCK_PAGER_LAYOUT_POLICY_WIDTH_FOR_HEIGHT: the #WnckPager is forced to resize its
- * width in proportion to a preset height. This can be used for instantiating a vertical
+ * @WNCK_PAGER_LAYOUT_POLICY_AUTOMATIC: the #WnckPager geometry management is
+ * "height for width" when in vertical orientation, or "width for height" when
+ * in horizontal orientation. This is the default behavior.
+ * @WNCK_PAGER_LAYOUT_POLICY_WIDTH_FOR_HEIGHT: the #WnckPager calculates its
+ * width in proportion to a preset height. This can be used for a vertical
  * #WnckPager inside a horizontal panel.
- * @WNCK_PAGER_LAYOUT_POLICY_HEIGHT_FOR_WIDTH: the #WnckPager is forced to resize its
- * height in proportion to a preset width. This can be used for instantiating a horizontal
+ * @WNCK_PAGER_LAYOUT_POLICY_HEIGHT_FOR_WIDTH: the #WnckPager calculates its
+ * height in proportion to a preset width. This can be used for a horizontal
  * #WnckPager inside a vertical panel.
  *
- * Policy defining how a #WnckPager will resize itself.
+ * Policy defining the geometry management used by a #WnckPager.
+ *
+ * Since: 2.32
  */
 typedef enum {
   WNCK_PAGER_LAYOUT_POLICY_AUTOMATIC,



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]