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

[From: subversion at stage.maemo.org]

Author: elmarco
Date: 2007-10-18 00:02:54 +0300 (Thu, 18 Oct 2007)
New Revision: 14494

Modified:
   projects/haf/trunk/hildon-desktop/ChangeLog
   projects/haf/trunk/hildon-desktop/libhildondesktop/libhildondesktop.h
Log:
2007-10-17  Marc-Andre Lureau  <marc-andre.lureau at nokia.com>

* libhildondesktop/libhildondesktop.h: document
HD_DEFINE_PLUGIN_EXTENDED and HD_DEFINE_PLUGIN.


Modified: projects/haf/trunk/hildon-desktop/ChangeLog
===================================================================
--- projects/haf/trunk/hildon-desktop/ChangeLog	2007-10-17 20:39:59 UTC (rev 14493)
+++ projects/haf/trunk/hildon-desktop/ChangeLog	2007-10-17 21:02:54 UTC (rev 14494)
@@ -1,5 +1,10 @@
 2007-10-17  Marc-Andre Lureau  <marc-andre.lureau at nokia.com>
 
+	* libhildondesktop/libhildondesktop.h: document
+	HD_DEFINE_PLUGIN_EXTENDED and HD_DEFINE_PLUGIN.
+
+2007-10-17  Marc-Andre Lureau  <marc-andre.lureau at nokia.com>
+
 	* libhildondesktop/tasknavigator-item.[ch]: document
 	TaskNavigatorItem (mark public fields as private).
 

Modified: projects/haf/trunk/hildon-desktop/libhildondesktop/libhildondesktop.h
===================================================================
--- projects/haf/trunk/hildon-desktop/libhildondesktop/libhildondesktop.h	2007-10-17 20:39:59 UTC (rev 14493)
+++ projects/haf/trunk/hildon-desktop/libhildondesktop/libhildondesktop.h	2007-10-17 21:02:54 UTC (rev 14494)
@@ -50,10 +50,36 @@
 #include <libhildondesktop/libhildonmenu.h>
 #include <libhildondesktop/hildon-thumb-menu-item.h>
 
+/**
+ * SECTION:libhildondesktop
+ * @short_description: macros to define Hildon Desktop plugins.
+ *
+ * @see_also: #StatusbarItem, #TaskNavigatorItem.
+ */
+
+/**
+ * HD_DEFINE_PLUGIN_EXTENDED:
+ * @TN: The name of the object type, in Camel case. (ex: ObjectType)
+ * @t_n: The name of the object type, in lowercase, with words separated by '_'.  (ex: object_type)
+ * @T_P: The GType of the parent (ex: #STATUSBAR_TYPE_ITEM)
+ * @CODE_LOAD: code executed when the plugin is loaded.
+ * @CODE_UNLOAD: code executed when the plugin is unloaded.
+ *
+ * Register an object supplied by a plugin in Hildon Desktop.
+ */
 #define HD_DEFINE_PLUGIN_EXTENDED(TN, t_n, T_P, CODE_LOAD, CODE_UNLOAD)      \
 HD_DEFINE_TYPE_MODULE_EXTENDED (TN, t_n, T_P, 0, {})       		     \
 HILDON_DESKTOP_PLUGIN_SYMBOLS_CODE (TN, t_n, T_P, 0, CODE_LOAD, CODE_UNLOAD)
 
+/**
+ * HD_DEFINE_PLUGIN:
+ * @TN: The name of the object type, in Camel case. (ex: ObjectType)
+ * @t_n: The name of the object type, in lowercase, with words separated by '_'.  (ex: object_type)
+ * @T_P: The GType of the parent (ex: #STATUSBAR_TYPE_ITEM)
+ *
+ * Register an object supplied by a plugin in Hildon Desktop.
+ * FIXME: link to an example.
+ */
 #define HD_DEFINE_PLUGIN(TN, t_n, T_P)			\
 HD_DEFINE_TYPE_MODULE_EXTENDED (TN, t_n, T_P, 0, {})	\
 HILDON_DESKTOP_PLUGIN_SYMBOLS (t_n)