[Xfce4-commits] [apps/xfdashboard] 01/01: Add gtk-doc documentation annotations to box-layout.{c, h}

[noreply at xfce.org]

This is an automated email from the git hooks/post-receive script.

nomad pushed a commit to branch master
in repository apps/xfdashboard.

commit c6f54161e0da534e1a1062fc8878ebf37522ed8f
Author: Stephan Haller <nomad at froevel.de>
Date:   Sun Aug 16 21:56:24 2015 +0200

    Add gtk-doc documentation annotations to box-layout.{c,h}
---
 xfdashboard/box-layout.c |   20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/xfdashboard/box-layout.c b/xfdashboard/box-layout.c
index ff6abf2..9fa9c64 100644
--- a/xfdashboard/box-layout.c
+++ b/xfdashboard/box-layout.c
@@ -23,6 +23,19 @@
  * 
  */
 
+/**
+ * SECTION:box-layout
+ * @short_description: A layout manager arranging children on a single line
+ * @include: xfdashboard/box-layout.h
+ *
+ * A #ClutterBoxLayout derived layout manager arranging children on a single line
+ * which disregards text direction.
+ *
+ * It behave like #ClutterBoxLayout but it enforces a left-to-right layout of
+ * all children when set to horizontal orientation. This is the difference of
+ * this layout manager to #ClutterBoxLayout.
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -127,6 +140,13 @@ static void xfdashboard_box_layout_init(XfdashboardBoxLayout *self)
 /* IMPLEMENTATION: Public API */
 
 /* Create new instance */
+/**
+ * xfdashboard_box_layout_new:
+ *
+ * Creates a new #XfdashboardBoxLayout layout manager
+ *
+ * Return value: The newly created #XfdashboardBoxLayout
+ */
 ClutterLayoutManager* xfdashboard_box_layout_new(void)
 {
 	return(CLUTTER_LAYOUT_MANAGER(g_object_new(XFDASHBOARD_TYPE_BOX_LAYOUT, NULL)));

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.