stefan pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=b8dfc68ee257ca0a853f4233a1e96de4febbc904
commit b8dfc68ee257ca0a853f4233a1e96de4febbc904
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date: Fri Nov 11 15:35:48 2016 +0100
docs: ecore_con: add all missing docs for ecore_con
This should fill all gaps we still had in ecore_con. Please make sure all
new
additions comes with docs as well.
---
src/lib/ecore_con/ecore_con_eet_base.eo | 2 +-
src/lib/ecore_con/efl_net_session.eo | 32 ++++++++++++++++----------------
src/lib/ecore_con/efl_net_ssl_context.eo | 18 +++++++++---------
3 files changed, 26 insertions(+), 26 deletions(-)
diff --git a/src/lib/ecore_con/ecore_con_eet_base.eo
b/src/lib/ecore_con/ecore_con_eet_base.eo
index 82d41a2..fcbc835 100644
--- a/src/lib/ecore_con/ecore_con_eet_base.eo
+++ b/src/lib/ecore_con/ecore_con_eet_base.eo
@@ -19,7 +19,7 @@ class Ecore.Con.Eet.Base (Efl.Object) {
get {
}
values {
- data: Efl.Network.Server;
+ data: Efl.Network.Server; [[Server object]]
}
}
@property data_callback {
diff --git a/src/lib/ecore_con/efl_net_session.eo
b/src/lib/ecore_con/efl_net_session.eo
index 83ee334..af792a2 100644
--- a/src/lib/ecore_con/efl_net_session.eo
+++ b/src/lib/ecore_con/efl_net_session.eo
@@ -3,9 +3,9 @@ enum Efl.Net.Session.State {
@since 1.19
]]
- offline, [[no access point is connected]]
- local, [[at least one access point was connected and the internet
connectio wasn't verified]]
- online, [[at least one access point was connected and the internet was
verified]]
+ offline, [[No access point is connected]]
+ local, [[At least one access point was connected and the internet
connectio wasn't verified]]
+ online, [[At least one access point was connected and the internet was
verified]]
}
/* keep in sync with efl_net_control_technology.eo, comment what doesn't make
sense */
@@ -42,7 +42,7 @@ class Efl.Net.Session (Efl.Loop_User) {
@since 1.19
]]
events {
- changed; [[Some properties were changed.]]
+ changed; [[Called when some properties were changed.]]
}
methods {
@@ -60,7 +60,7 @@ class Efl.Net.Session (Efl.Loop_User) {
https://github.com/aldebaran/connman/blob/master/doc/session-policy-format.txt
]]
params {
- online_required: bool; [[if $false, access points with local
state are enough. If $true, the access point must be in online state, with a
validated internet connection]]
+ online_required: bool; [[If $false, access points with local
state are enough. If $true, the access point must be in online state, with a
validated internet connection]]
technologies_allowed: Efl.Net.Session.Technology; [[Bitwise OR
of technologies to allow]]
}
}
@@ -79,7 +79,7 @@ class Efl.Net.Session (Efl.Loop_User) {
[[The user-friendly access point name.]]
get { }
values {
- name: string;
+ name: string; [[Access point name]]
}
}
@@ -87,7 +87,7 @@ class Efl.Net.Session (Efl.Loop_User) {
[[If the session connectivity is offline, local or online.]]
get { }
values {
- state: Efl.Net.Session.State;
+ state: Efl.Net.Session.State; [[Network session state]]
}
}
@@ -95,7 +95,7 @@ class Efl.Net.Session (Efl.Loop_User) {
[[The access point technology that backs this session]]
get { }
values {
- technology: Efl.Net.Session.Technology;
+ technology: Efl.Net.Session.Technology; [[Network session
technology]]
}
}
@@ -103,7 +103,7 @@ class Efl.Net.Session (Efl.Loop_User) {
[[The interface allows the application to assign the socket to a
given device using SO_BINDTODEVICE]]
get { }
values {
- interface: string;
+ interface: string; [[Network interface to bind to]]
}
}
@@ -111,9 +111,9 @@ class Efl.Net.Session (Efl.Loop_User) {
[[IPv4 in use for this session.]]
get { }
values {
- address: string;
- netmask: string;
- gateway: string;
+ address: string; [[IPv4 address]]
+ netmask: string; [[IPv4 netmask]]
+ gateway: string; [[IPv4 gateway]]
}
}
@@ -121,10 +121,10 @@ class Efl.Net.Session (Efl.Loop_User) {
[[IPv6 in use for this session.]]
get { }
values {
- address: string;
- prefix_length: uint8;
- netmask: string;
- gateway: string;
+ address: string; [[IPv6 address]]
+ prefix_length: uint8; [[IPv6 prefix]]
+ netmask: string; [[IPv6 netmask]]
+ gateway: string; [[IPv6 gateway]]
}
}
}
diff --git a/src/lib/ecore_con/efl_net_ssl_context.eo
b/src/lib/ecore_con/efl_net_ssl_context.eo
index 3c8caec..8549cdd 100644
--- a/src/lib/ecore_con/efl_net_ssl_context.eo
+++ b/src/lib/ecore_con/efl_net_ssl_context.eo
@@ -30,7 +30,7 @@ class Efl.Net.Ssl.Context (Efl.Object) {
]]
get { }
values {
- default_client_context: Efl.Net.Ssl.Context;
+ default_client_context: Efl.Net.Ssl.Context; [[Default SSL
context]]
}
}
@@ -45,42 +45,42 @@ class Efl.Net.Ssl.Context (Efl.Object) {
@property certificates {
[[The list of paths to certificates to use.]]
values {
- paths: free(own(iterator<string>), eina_iterator_free);
+ paths: free(own(iterator<string>), eina_iterator_free); [[Path
list for certificates]]
}
}
@property private_keys {
[[The list of paths to private keys to use.]]
values {
- paths: free(own(iterator<string>), eina_iterator_free);
+ paths: free(own(iterator<string>), eina_iterator_free); [[Path
list for private keys]]
}
}
@property certificate_revogation_lists {
[[The list of paths to CRL (certificate revogation list) to use.]]
values {
- paths: free(own(iterator<string>), eina_iterator_free);
+ paths: free(own(iterator<string>), eina_iterator_free); [[Path
list for CRL's]]
}
}
@property certificate_authorities {
[[The list of paths to CA (certificate authoritie) to use.]]
values {
- paths: free(own(iterator<string>), eina_iterator_free);
+ paths: free(own(iterator<string>), eina_iterator_free); [[Path
list for CA's]]
}
}
@property default_paths_load {
[[If $true, will use system's default certificate storage]]
values {
- default_paths_load: bool;
+ default_paths_load: bool; [[$if true use system default paths
for loading, $false otherwise]]
}
}
@property verify_mode {
[[How to verify the remote peer.]]
values {
- verify_mode: Efl.Net.Ssl.Verify_Mode;
+ verify_mode: Efl.Net.Ssl.Verify_Mode; [[Remote verification
mode]]
}
}
@@ -92,7 +92,7 @@ class Efl.Net.Ssl.Context (Efl.Object) {
@.hostname.
]]
values {
- hostname_verify: bool;
+ hostname_verify: bool; [[$true if the hostname will be
verified, $false otherwise]]
}
}
@@ -109,7 +109,7 @@ class Efl.Net.Ssl.Context (Efl.Object) {
It's only used if @.hostname_verify is $true.
]]
values {
- hostname: string @nullable;
+ hostname: string @nullable; [[Hostname for this socket]]
}
}
}
--
