stefan pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=f74c4bbce771e65017884b43f2a731bd19f1f6bf
commit f74c4bbce771e65017884b43f2a731bd19f1f6bf
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date: Wed Apr 20 12:45:09 2016 +0200
docs: eldbus: add class and property descriptions for eldbus model files
Also fix some existing docs while being there.
---
src/lib/eldbus/eldbus_model_arguments.eo | 3 +++
src/lib/eldbus/eldbus_model_connection.eo | 7 ++++++-
src/lib/eldbus/eldbus_model_method.eo | 1 +
src/lib/eldbus/eldbus_model_object.eo | 11 +++++++++--
src/lib/eldbus/eldbus_model_proxy.eo | 3 +++
src/lib/eldbus/eldbus_model_signal.eo | 2 ++
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 97ac163..5c11f97 100644
--- a/src/lib/eldbus/eldbus_model_arguments.eo
+++ b/src/lib/eldbus/eldbus_model_arguments.eo
@@ -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)*;
diff --git a/src/lib/eldbus/eldbus_model_connection.eo
b/src/lib/eldbus/eldbus_model_connection.eo
index 3f2e5ab..0c00b9f 100644
--- a/src/lib/eldbus/eldbus_model_connection.eo
+++ b/src/lib/eldbus/eldbus_model_connection.eo
@@ -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;
}
diff --git a/src/lib/eldbus/eldbus_model_method.eo
b/src/lib/eldbus/eldbus_model_method.eo
index 7947e25..5cc05d9 100644
--- a/src/lib/eldbus/eldbus_model_method.eo
+++ b/src/lib/eldbus/eldbus_model_method.eo
@@ -1,6 +1,7 @@
import eldbus_types;
class Eldbus.Model_Method (Eldbus.Model_Arguments) {
+ [[Eldbus model method class]]
legacy_prefix: null;
methods {
constructor {
diff --git a/src/lib/eldbus/eldbus_model_object.eo
b/src/lib/eldbus/eldbus_model_object.eo
index bb8ad63..2ccf638 100644
--- a/src/lib/eldbus/eldbus_model_object.eo
+++ b/src/lib/eldbus/eldbus_model_object.eo
@@ -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)*;
}
diff --git a/src/lib/eldbus/eldbus_model_proxy.eo
b/src/lib/eldbus/eldbus_model_proxy.eo
index 40f6d79..f328707 100644
--- a/src/lib/eldbus/eldbus_model_proxy.eo
+++ b/src/lib/eldbus/eldbus_model_proxy.eo
@@ -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)*;
diff --git a/src/lib/eldbus/eldbus_model_signal.eo
b/src/lib/eldbus/eldbus_model_signal.eo
index 2c61857..633e99c 100644
--- a/src/lib/eldbus/eldbus_model_signal.eo
+++ b/src/lib/eldbus/eldbus_model_signal.eo
@@ -1,4 +1,6 @@
class Eldbus.Model_Signal (Eldbus.Model_Arguments) {
+ [[Eldbus model signal class]]
+
legacy_prefix: null;
methods {
constructor {
--
