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 97ac163..5c11f97 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 3f2e5ab..0c00b9f 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 7947e25..5cc05d9 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 bb8ad63..2ccf638 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 40f6d79..f328707 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 2c61857..633e99c 100644 (file)
@@ -1,4 +1,6 @@
 class Eldbus.Model_Signal (Eldbus.Model_Arguments) {
+    [[Eldbus model signal class]]
+
     legacy_prefix: null;
     methods {
         constructor {