summaryrefslogtreecommitdiff
path: root/src/lib/eldbus/eldbus_types.eot
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-10-20 15:49:14 +0200
committerStefan Schmidt <stefan@osg.samsung.com>2016-10-20 17:45:33 +0200
commit30a049a7b7d001ada26124c0463bceb5dc754867 (patch)
treeb0f5e6e63623965f09cb0adf52667430b26dafee /src/lib/eldbus/eldbus_types.eot
parentf486be101cb8d85de70f43152e56e9b78532e371 (diff)
docs: eldbus: document all eldbus structs and its members
Diffstat (limited to 'src/lib/eldbus/eldbus_types.eot')
-rw-r--r--src/lib/eldbus/eldbus_types.eot69
1 files changed, 39 insertions, 30 deletions
diff --git a/src/lib/eldbus/eldbus_types.eot b/src/lib/eldbus/eldbus_types.eot
index a8c9dd3..5db9054 100644
--- a/src/lib/eldbus/eldbus_types.eot
+++ b/src/lib/eldbus/eldbus_types.eot
@@ -1,73 +1,82 @@
1import eina_types; 1import eina_types;
2 2
3struct Eldbus.Proxy; 3struct Eldbus.Proxy; [[Represents a client object bound to an interface]]
4struct Eldbus.Connection; [[Represents a connection of one the type of connection with the DBus daemon.]] 4struct Eldbus.Connection; [[Represents a connection of one the type of connection with the DBus daemon.]]
5struct Eldbus.Object; [[Represents an object path already attached with bus name or unique id]] 5struct Eldbus.Object; [[Represents an object path already attached with bus name or unique id]]
6 6
7enum Eldbus.Introspection.Argument_Direction 7enum Eldbus.Introspection.Argument_Direction
8{ 8{
9 none = 0, 9 [[Argument direction]]
10 in, 10 none = 0, [[No direction]]
11 out, 11 in, [[Incoming direction]]
12 out, [[Outgoing direction]]
12} 13}
13 14
14/* DTD conversion form: http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd */ 15/* DTD conversion form: http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd */
15 16
16enum Eldbus.Introspection.Property_Access 17enum Eldbus.Introspection.Property_Access
17{ 18{
18 read, 19 [[Property access rights]]
19 write, 20 read, [[Property can be read]]
20 readwrite, 21 write, [[Property can be written]]
22 readwrite, [[Property can be read and written]]
21} 23}
22 24
23/* FIXME: Properly type all of these lists. */ 25/* FIXME: Properly type all of these lists. */
24struct Eldbus.Introspection.Node 26struct Eldbus.Introspection.Node
25{ 27{
26 name: stringshare; [[optional]] 28 [[DBus Node]]
27 nodes: list<void *>; 29 name: stringshare; [[Node name (optional)]]
28 interfaces: list<void *>; 30 nodes: list<void *>; [[List with nodes]]
31 interfaces: list<void *>; [[List with interfaces]]
29} 32}
30 33
31struct Eldbus.Introspection.Interface 34struct Eldbus.Introspection.Interface
32{ 35{
33 name: stringshare; 36 [[DBus Interface]]
34 methods: list<void *>; 37 name: stringshare; [[Interface name]]
35 signals: list<void *>; 38 methods: list<void *>; [[List with interface methods]]
36 properties: list<void *>; 39 signals: list<void *>; [[List with interface signals]]
37 annotations: list<void *>; 40 properties: list<void *>; [[List with interface properties]]
41 annotations: list<void *>; [[List with interface annotations]]
38} 42}
39 43
40struct Eldbus.Introspection.Method 44struct Eldbus.Introspection.Method
41{ 45{
42 name: stringshare; 46 [[DBus Method]]
43 arguments: list<void *>; 47 name: stringshare; [[Method name]]
44 annotations: list<void *>; 48 arguments: list<void *>; [[List with method arguments]]
49 annotations: list<void *>; [[List with method annotations]]
45} 50}
46 51
47struct Eldbus.Introspection.Property 52struct Eldbus.Introspection.Property
48{ 53{
49 name: stringshare; 54 [[DBus Property]]
50 type: stringshare; 55 name: stringshare; [[Property name]]
51 access: Eldbus.Introspection.Property_Access; 56 type: stringshare; [[Property type]]
52 annotations: list<void *>; 57 access: Eldbus.Introspection.Property_Access; [[Property access rights]]
58 annotations: list<void *>; [[List with property annotations]]
53} 59}
54 60
55struct Eldbus.Introspection.Annotation 61struct Eldbus.Introspection.Annotation
56{ 62{
57 name: stringshare; 63 [[DBus Annotation]]
58 value: stringshare; 64 name: stringshare; [[Annotation name]]
65 value: stringshare; [[Annotation value]]
59} 66}
60 67
61struct Eldbus.Introspection.Argument 68struct Eldbus.Introspection.Argument
62{ 69{
63 name: stringshare; [[Optional]] 70 [[DBus Argument]]
64 type: stringshare; 71 name: stringshare; [[Argument name (optional)]]
65 direction: Eldbus.Introspection.Argument_Direction; 72 type: stringshare; [[Argument type]]
73 direction: Eldbus.Introspection.Argument_Direction; [[Argument direction]]
66} 74}
67 75
68struct Eldbus.Introspection.Signal 76struct Eldbus.Introspection.Signal
69{ 77{
70 name: stringshare; 78 [[DBus Signal]]
71 arguments: list<Eldbus.Introspection.Argument *>; 79 name: stringshare; [[Signal name]]
72 annotations: list<Eldbus.Introspection.Annotation *>; 80 arguments: list<Eldbus.Introspection.Argument *>; [[List with signal arguments]]
81 annotations: list<Eldbus.Introspection.Annotation *>; [[List with signal annotations]]
73} 82}