docs: eldbus: add class and property descriptions for eldbus model files
authorStefan Schmidt <stefan@osg.samsung.com>
Wed, 20 Apr 2016 10:45:09 +0000 (12:45 +0200)
committerStefan Schmidt <stefan@osg.samsung.com>
Wed, 20 Apr 2016 10:46:41 +0000 (12:46 +0200)
Also fix some existing docs while being there.

src/lib/eldbus/eldbus_model_arguments.eo
src/lib/eldbus/eldbus_model_connection.eo
src/lib/eldbus/eldbus_model_method.eo
src/lib/eldbus/eldbus_model_object.eo
src/lib/eldbus/eldbus_model_proxy.eo
src/lib/eldbus/eldbus_model_signal.eo

index 97ac16360556e605640a5fb9f2ce09a81949dd58..5c11f97b6bc92608d23961b9cdf8d9d0d9512def 100644 (file)
@@ -1,6 +1,8 @@
 import eldbus_types;
 
 class Eldbus.Model_Arguments (Eo.Base, Efl.Model.Base) {
+    [[Eldbus model arguments class]]
+
     legacy_prefix: null;
     methods {
         constructor {
@@ -14,6 +16,7 @@ class Eldbus.Model_Arguments (Eo.Base, Efl.Model.Base) {
             }
         }
     @property name {
+            [[Name of the argument]]
             get {}
             values {
                 value: const(char)*;
index 3f2e5ab38989e6d746b5b7c5c1397c7291204926..0c00b9f32755658a05c939c9efaff1e7999ee8b5 100644 (file)
@@ -1,4 +1,6 @@
 class Eldbus.Model_Connection (Eo.Base, Efl.Model.Base) {
+    [[Eldbus model connection class]]
+
     legacy_prefix: null;
     methods {
         constructor {
@@ -7,21 +9,24 @@ class Eldbus.Model_Connection (Eo.Base, Efl.Model.Base) {
               @since 1.16]]
             params {
                 @in type: int; [[The connection type]]
-                @in address: const(char)*; [[Remote address of dbus]]
+                @in address: const(char)*; [[Remote address of DBus]]
                 @in private_: bool; [[Non shared dbus connection]]
             }
         }
     @property type {
+            [[Connection type]]
             values {
                 value: int;
             }
         }
     @property address {
+            [[Remote DBus address]]
             values {
                 value: const(char)*;
             }
         }
     @property private {
+            [[Indicate if the DBus connection is shared or private]]
             values {
                 value: bool;
             }
index 7947e25b72b48572ebf7f7ec0f3e856d5cdd9fb4..5cc05d9e543afacaaa7e9f701f8547687054c0e2 100644 (file)
@@ -1,6 +1,7 @@
 import eldbus_types;
 
 class Eldbus.Model_Method (Eldbus.Model_Arguments) {
+    [[Eldbus model method class]]
     legacy_prefix: null;
     methods {
         constructor {
index bb8ad63c75fc61e337066f6e01816b62e891c0bc..2ccf638f88160283535e00287b6b2c936fc43006 100644 (file)
@@ -1,6 +1,8 @@
 import eldbus_types;
 
 class Eldbus.Model_Object (Eo.Base, Efl.Model.Base) {
+    [[Eldbus model object class]]
+
     legacy_prefix: null;
     data: Eldbus_Model_Object_Data;
     methods {
@@ -10,8 +12,8 @@ class Eldbus.Model_Object (Eo.Base, Efl.Model.Base) {
               @since 1.16]]
             params {
                 @in type: int; [[The connection type]]
-                @in address: const(char)*; [[Remote address of dbus]]
-                @in private_: bool; [[Non shared dbus connection]]
+                @in address: const(char)*; [[Remote address of DBus]]
+                @in private_: bool; [[Non shared DBus connection]]
                 @in bus: const(char)*; [[DBus Name or unique-id]]
                 @in path: const(char)*; [[DBus path]]
             }
@@ -27,26 +29,31 @@ class Eldbus.Model_Object (Eo.Base, Efl.Model.Base) {
             }
         }
     @property type {
+            [[Connection type]]
             values {
                 value: int;
             }
         }
     @property address {
+            [[Remote address of DBus]]
             values {
                 value: const(char)*;
             }
         }
     @property private {
+            [[Indicate if the DBus connection is shared or private]]
             values {
                 value: bool;
             }
         }
     @property bus {
+            [[DBus Name or unique-id]]
             values {
                 value: const(char)*;
             }
         }
     @property path {
+            [[DBus path]]
             values {
                 value: const(char)*;
             }
index 40f6d796a4251972c479ca6d90d9b75fe1bbcb91..f328707fc22de2da8f2327f44cb4302c8853df80 100644 (file)
@@ -1,6 +1,8 @@
 import eldbus_types;
 
 class Eldbus.Model_Proxy (Eo.Base, Efl.Model.Base) {
+    [[Eldbus model proxy class]]
+
     legacy_prefix: null;
     methods {
         constructor {
@@ -13,6 +15,7 @@ class Eldbus.Model_Proxy (Eo.Base, Efl.Model.Base) {
             }
         }
     @property name {
+            [[Proxy name]]
             get {}
             values {
                 value: const(char)*;
index 2c6185722b62668f1893c786882b433ca41380d3..633e99cba4c4bc93b9b261d11a2a496c347a938b 100644 (file)
@@ -1,4 +1,6 @@
 class Eldbus.Model_Signal (Eldbus.Model_Arguments) {
+    [[Eldbus model signal class]]
+
     legacy_prefix: null;
     methods {
         constructor {