summaryrefslogtreecommitdiff
path: root/src/lib/eldbus
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-04-20 12:45:09 +0200
committerStefan Schmidt <stefan@osg.samsung.com>2016-04-20 12:46:41 +0200
commitf74c4bbce771e65017884b43f2a731bd19f1f6bf (patch)
tree91fe41ab315dc5ff6ea1da5f4ab4af37194dd1f5 /src/lib/eldbus
parent3e4a90227026ac1ff85a620c2210af097b03a24c (diff)
docs: eldbus: add class and property descriptions for eldbus model files
Also fix some existing docs while being there.
Diffstat (limited to 'src/lib/eldbus')
-rw-r--r--src/lib/eldbus/eldbus_model_arguments.eo3
-rw-r--r--src/lib/eldbus/eldbus_model_connection.eo7
-rw-r--r--src/lib/eldbus/eldbus_model_method.eo1
-rw-r--r--src/lib/eldbus/eldbus_model_object.eo11
-rw-r--r--src/lib/eldbus/eldbus_model_proxy.eo3
-rw-r--r--src/lib/eldbus/eldbus_model_signal.eo2
6 files changed, 24 insertions, 3 deletions
diff --git a/src/lib/eldbus/eldbus_model_arguments.eo b/src/lib/eldbus/eldbus_model_arguments.eo
index 97ac163605..5c11f97b6b 100644
--- a/src/lib/eldbus/eldbus_model_arguments.eo
+++ b/src/lib/eldbus/eldbus_model_arguments.eo
@@ -1,6 +1,8 @@
1import eldbus_types; 1import eldbus_types;
2 2
3class Eldbus.Model_Arguments (Eo.Base, Efl.Model.Base) { 3class Eldbus.Model_Arguments (Eo.Base, Efl.Model.Base) {
4 [[Eldbus model arguments class]]
5
4 legacy_prefix: null; 6 legacy_prefix: null;
5 methods { 7 methods {
6 constructor { 8 constructor {
@@ -14,6 +16,7 @@ class Eldbus.Model_Arguments (Eo.Base, Efl.Model.Base) {
14 } 16 }
15 } 17 }
16 @property name { 18 @property name {
19 [[Name of the argument]]
17 get {} 20 get {}
18 values { 21 values {
19 value: const(char)*; 22 value: const(char)*;
diff --git a/src/lib/eldbus/eldbus_model_connection.eo b/src/lib/eldbus/eldbus_model_connection.eo
index 3f2e5ab389..0c00b9f327 100644
--- a/src/lib/eldbus/eldbus_model_connection.eo
+++ b/src/lib/eldbus/eldbus_model_connection.eo
@@ -1,4 +1,6 @@
1class Eldbus.Model_Connection (Eo.Base, Efl.Model.Base) { 1class Eldbus.Model_Connection (Eo.Base, Efl.Model.Base) {
2 [[Eldbus model connection class]]
3
2 legacy_prefix: null; 4 legacy_prefix: null;
3 methods { 5 methods {
4 constructor { 6 constructor {
@@ -7,21 +9,24 @@ class Eldbus.Model_Connection (Eo.Base, Efl.Model.Base) {
7 @since 1.16]] 9 @since 1.16]]
8 params { 10 params {
9 @in type: int; [[The connection type]] 11 @in type: int; [[The connection type]]
10 @in address: const(char)*; [[Remote address of dbus]] 12 @in address: const(char)*; [[Remote address of DBus]]
11 @in private_: bool; [[Non shared dbus connection]] 13 @in private_: bool; [[Non shared dbus connection]]
12 } 14 }
13 } 15 }
14 @property type { 16 @property type {
17 [[Connection type]]
15 values { 18 values {
16 value: int; 19 value: int;
17 } 20 }
18 } 21 }
19 @property address { 22 @property address {
23 [[Remote DBus address]]
20 values { 24 values {
21 value: const(char)*; 25 value: const(char)*;
22 } 26 }
23 } 27 }
24 @property private { 28 @property private {
29 [[Indicate if the DBus connection is shared or private]]
25 values { 30 values {
26 value: bool; 31 value: bool;
27 } 32 }
diff --git a/src/lib/eldbus/eldbus_model_method.eo b/src/lib/eldbus/eldbus_model_method.eo
index 7947e25b72..5cc05d9e54 100644
--- a/src/lib/eldbus/eldbus_model_method.eo
+++ b/src/lib/eldbus/eldbus_model_method.eo
@@ -1,6 +1,7 @@
1import eldbus_types; 1import eldbus_types;
2 2
3class Eldbus.Model_Method (Eldbus.Model_Arguments) { 3class Eldbus.Model_Method (Eldbus.Model_Arguments) {
4 [[Eldbus model method class]]
4 legacy_prefix: null; 5 legacy_prefix: null;
5 methods { 6 methods {
6 constructor { 7 constructor {
diff --git a/src/lib/eldbus/eldbus_model_object.eo b/src/lib/eldbus/eldbus_model_object.eo
index bb8ad63c75..2ccf638f88 100644
--- a/src/lib/eldbus/eldbus_model_object.eo
+++ b/src/lib/eldbus/eldbus_model_object.eo
@@ -1,6 +1,8 @@
1import eldbus_types; 1import eldbus_types;
2 2
3class Eldbus.Model_Object (Eo.Base, Efl.Model.Base) { 3class Eldbus.Model_Object (Eo.Base, Efl.Model.Base) {
4 [[Eldbus model object class]]
5
4 legacy_prefix: null; 6 legacy_prefix: null;
5 data: Eldbus_Model_Object_Data; 7 data: Eldbus_Model_Object_Data;
6 methods { 8 methods {
@@ -10,8 +12,8 @@ class Eldbus.Model_Object (Eo.Base, Efl.Model.Base) {
10 @since 1.16]] 12 @since 1.16]]
11 params { 13 params {
12 @in type: int; [[The connection type]] 14 @in type: int; [[The connection type]]
13 @in address: const(char)*; [[Remote address of dbus]] 15 @in address: const(char)*; [[Remote address of DBus]]
14 @in private_: bool; [[Non shared dbus connection]] 16 @in private_: bool; [[Non shared DBus connection]]
15 @in bus: const(char)*; [[DBus Name or unique-id]] 17 @in bus: const(char)*; [[DBus Name or unique-id]]
16 @in path: const(char)*; [[DBus path]] 18 @in path: const(char)*; [[DBus path]]
17 } 19 }
@@ -27,26 +29,31 @@ class Eldbus.Model_Object (Eo.Base, Efl.Model.Base) {
27 } 29 }
28 } 30 }
29 @property type { 31 @property type {
32 [[Connection type]]
30 values { 33 values {
31 value: int; 34 value: int;
32 } 35 }
33 } 36 }
34 @property address { 37 @property address {
38 [[Remote address of DBus]]
35 values { 39 values {
36 value: const(char)*; 40 value: const(char)*;
37 } 41 }
38 } 42 }
39 @property private { 43 @property private {
44 [[Indicate if the DBus connection is shared or private]]
40 values { 45 values {
41 value: bool; 46 value: bool;
42 } 47 }
43 } 48 }
44 @property bus { 49 @property bus {
50 [[DBus Name or unique-id]]
45 values { 51 values {
46 value: const(char)*; 52 value: const(char)*;
47 } 53 }
48 } 54 }
49 @property path { 55 @property path {
56 [[DBus path]]
50 values { 57 values {
51 value: const(char)*; 58 value: const(char)*;
52 } 59 }
diff --git a/src/lib/eldbus/eldbus_model_proxy.eo b/src/lib/eldbus/eldbus_model_proxy.eo
index 40f6d796a4..f328707fc2 100644
--- a/src/lib/eldbus/eldbus_model_proxy.eo
+++ b/src/lib/eldbus/eldbus_model_proxy.eo
@@ -1,6 +1,8 @@
1import eldbus_types; 1import eldbus_types;
2 2
3class Eldbus.Model_Proxy (Eo.Base, Efl.Model.Base) { 3class Eldbus.Model_Proxy (Eo.Base, Efl.Model.Base) {
4 [[Eldbus model proxy class]]
5
4 legacy_prefix: null; 6 legacy_prefix: null;
5 methods { 7 methods {
6 constructor { 8 constructor {
@@ -13,6 +15,7 @@ class Eldbus.Model_Proxy (Eo.Base, Efl.Model.Base) {
13 } 15 }
14 } 16 }
15 @property name { 17 @property name {
18 [[Proxy name]]
16 get {} 19 get {}
17 values { 20 values {
18 value: const(char)*; 21 value: const(char)*;
diff --git a/src/lib/eldbus/eldbus_model_signal.eo b/src/lib/eldbus/eldbus_model_signal.eo
index 2c6185722b..633e99cba4 100644
--- a/src/lib/eldbus/eldbus_model_signal.eo
+++ b/src/lib/eldbus/eldbus_model_signal.eo
@@ -1,4 +1,6 @@
1class Eldbus.Model_Signal (Eldbus.Model_Arguments) { 1class Eldbus.Model_Signal (Eldbus.Model_Arguments) {
2 [[Eldbus model signal class]]
3
2 legacy_prefix: null; 4 legacy_prefix: null;
3 methods { 5 methods {
4 constructor { 6 constructor {