[maemo-commits] [maemo-commits] r13128 - in projects/haf/trunk/hildon-desktop: . doc libhildondesktop

[From: subversion at stage.maemo.org]

Author: jobi
Date: 2007-08-10 18:22:36 +0300 (Fri, 10 Aug 2007)
New Revision: 13128

Modified:
   projects/haf/trunk/hildon-desktop/ChangeLog
   projects/haf/trunk/hildon-desktop/doc/Makefile.am
   projects/haf/trunk/hildon-desktop/doc/hildon-desktop.types
   projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-home-item.c
   projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-item.c
Log:
2007-08-10  Johan Bilien  <johan.bilien at nokia.com>

	* libhildondesktop/hildon-desktop-item.c:
	- some API doc



Modified: projects/haf/trunk/hildon-desktop/ChangeLog
===================================================================
--- projects/haf/trunk/hildon-desktop/ChangeLog	2007-08-10 15:22:02 UTC (rev 13127)
+++ projects/haf/trunk/hildon-desktop/ChangeLog	2007-08-10 15:22:36 UTC (rev 13128)
@@ -1,5 +1,10 @@
 2007-08-10  Johan Bilien  <johan.bilien at nokia.com>
 
+	* libhildondesktop/hildon-desktop-item.c:
+	- some API doc
+
+2007-08-10  Johan Bilien  <johan.bilien at nokia.com>
+
 	* libhildondesktop/hildon-desktop-home-item.h,
 	  libhildondesktop/hildon-home-area.c:
 	- move keyfile keys for applet layout where they belong

Modified: projects/haf/trunk/hildon-desktop/doc/Makefile.am
===================================================================
--- projects/haf/trunk/hildon-desktop/doc/Makefile.am	2007-08-10 15:22:02 UTC (rev 13127)
+++ projects/haf/trunk/hildon-desktop/doc/Makefile.am	2007-08-10 15:22:36 UTC (rev 13128)
@@ -29,9 +29,9 @@
 content_files		= version.xml 
 #			  visual_index.xml
 
-GTKDOC_CFLAGS		= $(HILDON_CFLAGS)
+GTKDOC_CFLAGS		= $(hildon_desktop_CFLAGS)
 
-GTKDOC_LIBS		= $(HILDON_LIBS)
+GTKDOC_LIBS		= $(hildon_desktop_LIBS)
 
 HTML_IMAGES		=
 

Modified: projects/haf/trunk/hildon-desktop/doc/hildon-desktop.types
===================================================================
--- projects/haf/trunk/hildon-desktop/doc/hildon-desktop.types	2007-08-10 15:22:02 UTC (rev 13127)
+++ projects/haf/trunk/hildon-desktop/doc/hildon-desktop.types	2007-08-10 15:22:36 UTC (rev 13128)
@@ -4,3 +4,8 @@
 #include <libhildondesktop/statusbar-item.h>
 #include <libhildondesktop/tasknavigator-item.h>
 
+hildon_desktop_item_get_type
+hildon_desktop_home_item_get_type
+hildon_desktop_panel_item_get_type
+statusbar_item_get_type
+tasknavigator_item_get_type

Modified: projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-home-item.c
===================================================================
--- projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-home-item.c	2007-08-10 15:22:02 UTC (rev 13127)
+++ projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-home-item.c	2007-08-10 15:22:36 UTC (rev 13128)
@@ -208,6 +208,12 @@
                                     GdkEventButton              *button);
 
 
+/**
+ * hildon_desktop_home_item_resize_type_get_type:
+ * @returns: the GType for #HildonDesktopHomeItemResizeType
+ *
+ * Registers and returns the GType for #HildonDesktopHomeItemResizeType
+ **/
 GType
 hildon_desktop_home_item_resize_type_get_type (void)
 {
@@ -236,6 +242,12 @@
 }
 
 
+/**
+ * hildon_desktop_home_item_get_type:
+ * @returns: the GType for #HildonDesktopHomeItem
+ *
+ * Registers and returns the GType for #HildonDesktopHomeItem
+ **/
 GType
 hildon_desktop_home_item_get_type (void)
 {

Modified: projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-item.c
===================================================================
--- projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-item.c	2007-08-10 15:22:02 UTC (rev 13127)
+++ projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-item.c	2007-08-10 15:22:36 UTC (rev 13128)
@@ -257,6 +257,13 @@
   }
 }
 
+/**
+ * hildon_desktop_item_get_widget:
+ * @item: a #HildonDesktopItem
+ * @returns: the child widget
+ *
+ * Returns the child widget of a #HildonDesktopItem
+ **/
 GtkWidget *
 hildon_desktop_item_get_widget (HildonDesktopItem *item)
 {
@@ -265,6 +272,14 @@
   return GTK_BIN (item)->child;
 }
 
+/**
+ * hildon_desktop_item_get_id:
+ * @item: a #HildonDesktopItem
+ * @returns: the item's identifier
+ *
+ * Returns a #HildonDesktopItem 's identifier. The identifier is used
+ * internally to associate items with container configuration.
+ **/
 const gchar *
 hildon_desktop_item_get_id (HildonDesktopItem *item)
 {
@@ -273,6 +288,13 @@
   return item->id;
 }
 
+/**
+ * hildon_desktop_item_get_name:
+ * @item: a #HildonDesktopItem
+ * @returns: the item's name
+ *
+ * Returns a #HildonDesktopItem 's name.
+ **/
 const gchar *
 hildon_desktop_item_get_name (HildonDesktopItem *item)
 {
@@ -281,6 +303,14 @@
   return item->name;
 }
 
+/**
+ * hildon_desktop_item_find_by_id:
+ * @item: a #HildonDesktopItem
+ * @id: the id to look for.
+ * @returns: 0 if the item has this id, not 0 otherwise.
+ *
+ * Checks whether this item has the given id. Used as a GList find function.
+ **/
 gint
 hildon_desktop_item_find_by_id (HildonDesktopItem *item,
                                 const gchar *id)