Enlightenment CVS committal

Author  : davemds
Project : e17
Module  : libs/etk

Dir     : e17/libs/etk/src/lib


Modified Files:
        etk_toolbar.c 


Log Message:
add missing documentation

===================================================================
RCS file: /cvs/e/e17/libs/etk/src/lib/etk_toolbar.c,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -3 -r1.18 -r1.19
--- etk_toolbar.c       28 Sep 2007 20:11:29 -0000      1.18
+++ etk_toolbar.c       13 Jul 2008 19:24:55 -0000      1.19
@@ -23,7 +23,7 @@
 #define ETK_IS_TOOL_ITEM(obj) \
    (ETK_IS_TOOL_BUTTON(obj) || ETK_IS_TOOL_TOGGLE_BUTTON(obj))
 
-enum Etk_Window_Property_Id
+enum Etk_Toolbar_Property_Id
 {
    ETK_TOOLBAR_ORIENTATION_PROPERTY,
    ETK_TOOLBAR_STYLE_PROPERTY,
@@ -492,3 +492,38 @@
 }
 
 /** @} */
+
+/**************************
+ *
+ * Documentation
+ *
+ **************************/
+
+/**
+ * @addtogroup Etk_Toolbar
+ *
+ * @image html widgets/toolbar.png
+ * Some toolbar description here
+ *
+ * \par Object Hierarchy:
+ * - Etk_Object
+ *   - Etk_Widget
+ *     - Etk_Container
+ *       - Etk_Toolbar
+ *
+ * \par Properties:
+ * @prop_name "orientation": The orientation of the toolbar, can be 
ETK_TOOLBAR_HORIZ or ETK_TOOLBAR_VERT.
+ * @prop_type Integer (Etk_Toolbar_Orientation)
+ * @prop_rw
+ * @prop_val ETK_TOOLBAR_HORIZ
+ * \par
+ * @prop_name "style": The buttons look in the toolbar, can be one of 
ETK_BUTTON_ICON, ETK_BUTTON_TEXT, ETK_BUTTON_BOTH_HORIZ or ETK_BUTTON_BOTH_VERT.
+ * @prop_type Integer (Etk_Button_Style)
+ * @prop_rw
+ * @prop_val ETK_TOOLBAR_BOTH_VERT
+ * \par
+ * @prop_name "stock-size":  The size of the stock-icons used by buttons.
+ * @prop_type Integer (Etk_Stock_Size)
+ * @prop_rw
+ * @prop_val ETK_STOCK_MEDIUM
+ */



-------------------------------------------------------------------------
Sponsored by: SourceForge.net Community Choice Awards: VOTE NOW!
Studies have shown that voting for your favorite open source project,
along with a healthy diet, reduces your potential for chronic lameness
and boredom. Vote Now at http://www.sourceforge.net/community/cca08
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs

Reply via email to