dundee: Add missing SetProperty documenation
authorDaniel Wagner <daniel.wagner@bmw-carit.de>
Fri, 17 Aug 2012 12:58:11 +0000 (14:58 +0200)
committerDaniel Wagner <daniel.wagner@bmw-carit.de>
Fri, 17 Aug 2012 12:59:50 +0000 (14:59 +0200)
doc/dundee-api.txt

index 9f4cfe6..11e988d 100644 (file)
@@ -41,6 +41,17 @@ Methods              dict GetProperties()
                        Returns properties for the device object. See
                        the properties section for available properties.
 
+               void SetProperty(string property, variant value)
+
+                       Changes the value of the specified property. Only
+                       properties that are listed as readwrite are
+                       changeable. On success a PropertyChanged signal
+                       will be emitted.
+
+                       Possible Errors: [service].Error.Timedout
+                                        [service].Error.InvalidArguments
+                                        [service].Error.Failed
+
 Signals                PropertyChanged(string name, variant value)
 
                        This signal indicates a changed value of the given