summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-11-10 17:45:11 +0100
committerStefan Schmidt <stefan@osg.samsung.com>2016-11-11 08:34:11 +0100
commitc588d49caa67071ef36fe107bb781c5abaf63358 (patch)
tree8976fda90792d3d48e8e0ba64459e079ff8d8b9b
parent8ee79d0e2101930aa2d0a5d38558132511f133d2 (diff)
downloadefl-c588d49caa67071ef36fe107bb781c5abaf63358.tar.gz
docs: efl_net*: add docs for newly added enums
-rw-r--r--src/lib/ecore_con/efl_net_control_access_point.eo2
-rw-r--r--src/lib/ecore_con/efl_net_control_technology.eo30
-rw-r--r--src/lib/ecore_con/efl_net_session.eo24
3 files changed, 28 insertions, 28 deletions
diff --git a/src/lib/ecore_con/efl_net_control_access_point.eo b/src/lib/ecore_con/efl_net_control_access_point.eo
index 041d87314e..469457b2fa 100644
--- a/src/lib/ecore_con/efl_net_control_access_point.eo
+++ b/src/lib/ecore_con/efl_net_control_access_point.eo
@@ -30,7 +30,7 @@ enum Efl.Net.Control.Access_Point.Security {
@since 1.19
]]
- unknow = 0,
+ unknow = 0, [[Unknown]]
none = (1 << 0), [[open access, no security]]
wep = (1 << 1), [[WEP]]
psk = (1 << 2), [[PSK (Pre Shared Key), such as WPA or RSN]]
diff --git a/src/lib/ecore_con/efl_net_control_technology.eo b/src/lib/ecore_con/efl_net_control_technology.eo
index d91f94723a..26ef8df96f 100644
--- a/src/lib/ecore_con/efl_net_control_technology.eo
+++ b/src/lib/ecore_con/efl_net_control_technology.eo
@@ -3,16 +3,16 @@ enum Efl.Net.Control.Technology.Type {
@since 1.19
]]
- unknown,
- system,
- ethernet,
- wifi,
- bluetooth,
- cellular,
- gps,
- vpn,
- gadget,
- p2p,
+ unknown, [[Type: unknown]]
+ system, [[Type: system]]
+ ethernet, [[Type: ethernet]]
+ wifi, [[Type: WiFi]]
+ bluetooth, [[Type: Bluetooth]]
+ cellular, [[Type: cellular/mobile]]
+ gps, [[Type: GPS]]
+ vpn, [[Type: Virtual Private Network]]
+ gadget, [[Type: USB gadget]]
+ p2p, [[Type: Peer-2-Peer]]
}
class Efl.Net.Control.Technology (Efl.Loop_User) {
@@ -37,7 +37,7 @@ class Efl.Net.Control.Technology (Efl.Loop_User) {
get { }
set { }
values {
- powered: bool;
+ powered: bool; [[$true if technology is powered, $false otherwise]]
}
}
@@ -61,7 +61,7 @@ class Efl.Net.Control.Technology (Efl.Loop_User) {
[[If $true the technology has at least one access point connected.]]
get { }
values {
- connected: bool;
+ connected: bool;[[$true if technology is connected, $false otherwise]]
}
}
@@ -69,7 +69,7 @@ class Efl.Net.Control.Technology (Efl.Loop_User) {
[[The user-friendly technology name]]
get { }
values {
- name: string;
+ name: string; [[Technology name]]
}
}
@@ -77,7 +77,7 @@ class Efl.Net.Control.Technology (Efl.Loop_User) {
[[The technology type, such as "ethernet" or "wifi"]]
get { }
values {
- type: Efl.Net.Control.Technology.Type;
+ type: Efl.Net.Control.Technology.Type; [[Technology type]]
}
}
@@ -96,7 +96,7 @@ class Efl.Net.Control.Technology (Efl.Loop_User) {
state. Otherwise prefer to let the system passively do
scans in a timely manner.
]]
- return: future<void_ptr>; /* NOTE: This should be future<void> */
+ return: future<void_ptr>; [[Future return for finished background scan]] /* NOTE: This should be future<void> */
}
}
diff --git a/src/lib/ecore_con/efl_net_session.eo b/src/lib/ecore_con/efl_net_session.eo
index db85815158..83ee3344e3 100644
--- a/src/lib/ecore_con/efl_net_session.eo
+++ b/src/lib/ecore_con/efl_net_session.eo
@@ -12,19 +12,19 @@ enum Efl.Net.Session.State {
enum Efl.Net.Session.Technology {
[[Bitwise-able technologies to allow for a network session.
- @since 1.19
+ @since 1.9
]]
- unknown = 0,
-/* system = (1 << 0), */
- ethernet = (1 << 1),
- wifi = (1 << 2),
- bluetooth = (1 << 3),
- cellular = (1 << 4),
-/* gps = (1 << 5), */
- vpn = (1 << 6),
- gadget = (1 << 7),
-/* p2p = (1 << 8), */
- all = (Efl.Net.Session.Technology.ethernet | Efl.Net.Session.Technology.wifi | Efl.Net.Session.Technology.bluetooth | Efl.Net.Session.Technology.cellular | Efl.Net.Session.Technology.vpn | Efl.Net.Session.Technology.gadget),
+ unknown = 0, [[Type: unknown]]
+/* system = (1 << 0), [[Type: system]]*/
+ ethernet = (1 << 1), [[Type: ethernet]]
+ wifi = (1 << 2), [[Type: WiFi]]
+ bluetooth = (1 << 3), [[Type: Bluetooth]]
+ cellular = (1 << 4), [[Type: cellular/mobile]]
+/* gps = (1 << 5), [[Type: GPS]]*/
+ vpn = (1 << 6), [[Type: Virtual Private Network]]
+ gadget = (1 << 7), [[Type: USB gadget]]
+/* p2p = (1 << 8), [[Type: Peer-2-Peer]]*/
+ all = (Efl.Net.Session.Technology.ethernet | Efl.Net.Session.Technology.wifi | Efl.Net.Session.Technology.bluetooth | Efl.Net.Session.Technology.cellular | Efl.Net.Session.Technology.vpn | Efl.Net.Session.Technology.gadget), [[All technology types]]
}
class Efl.Net.Session (Efl.Loop_User) {