Add documentantion for ContextMenu.qml.

2011-12-22 13:05:17 -02:00 · 2011-12-22 13:05:17 -02:00 · 7eeceac15d
commit 7eeceac15d
parent fe1c771a76
1 changed files with 22 additions and 0 deletions
--- a/declarativeimports/plasmacomponents/qml/ContextMenu.qml
+++ b/declarativeimports/plasmacomponents/qml/ContextMenu.qml
@ -40,6 +40,28 @@
 **
 ****************************************************************************/

+/**Documented API
+Inherits:
+        Item
+
+Imports:
+        QtQuick 1.1
+	org.kde.plasma.components
+
+Description:
+        Provides a component with list of options that the user can choose from.
+
+Properties:
+      * QtObject model
+        This property holds the model providing data for the menu.
+        The model provides the set of data that is used to create the items in the view.
+	Each model item must have a property called "text" or "display".
+
+Methods:
+      * void rebuildMenu()
+        Rebuild the menu if property model is defined.
+**/
+
 import QtQuick 1.1
 import org.kde.plasma.components 0.1