borisfaure
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ecore_con: convert doc of ecore_con_eet.eo 

Summary:
converted docs of ecore_con_eet.eo to the new style.

Signed-off-by: Srivardhan Hebbar <sri.hebbar@samsung.com>

Reviewers: cedric, tasn

Subscribers: yashu21985, cedric

Differential Revision: https://phab.enlightenment.org/D2795
This commit is contained in:
Srivardhan Hebbar 2015-07-06 10:20:28 +01:00 committed by Tom Hacohen
parent 851e1b5cba
commit c0731cdd51
1 changed files with 34 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
src/lib/ecore_con/ecore_con_eet_base.eo
View File

@ -3,9 +3,7 @@ class Ecore.Con.Eet.Base (Eo.Base) {
eo_prefix: ecore_con_eet_base; eo_prefix: ecore_con_eet_base;
methods { methods {
@property server { @property server {
/*@ [[The server object to which we send and receive.]]
* The server object to which we send and receive.
*/
set { set {
} }
get { get {
@ -15,83 +13,69 @@ class Ecore.Con.Eet.Base (Eo.Base) {
} }
} }
@property data_callback { @property data_callback {
/*@ [[A callback function which should be called when data is
* A callback function which should be called when data is received by ecore_con_eet_object.]]
* received by ecore_con_eet_object.
*/
set { set {
} }
values { values {
name: const (char) *; /*@ The name of the eet stream. */ name: const (char) *; [[The name of the eet stream.]]
func: Ecore_Con_Eet_Data_Cb; /*@ The callback function. */ func: Ecore_Con_Eet_Data_Cb; [[The callback function.]]
data: const (void) *; /*@ The data (if any) that should be data: const (void) *; [[The data (if any) that should be
* passed to callback function. */ passed to callback function.]]
} }
} }
@property raw_data_callback { @property raw_data_callback {
/*@ [[A callback function which should be calledn when raw data
* A callback function which should be calledn when raw data is received by ecore_con_eet_object.]]
* is received by ecore_con_eet_object.
*/
set { set {
} }
values { values {
name: const (char) *; /*@ The name of the eet stream. */ name: const (char) *; [[The name of the eet stream.]]
func: Ecore_Con_Eet_Raw_Data_Cb; /*@ The callback function. */ func: Ecore_Con_Eet_Raw_Data_Cb; [[The callback function.]]
data: const (void) *; /* The data (if any) that should be data: const (void) *; [[The data (if any) that should be
* passed to callback function. */ passed to callback function.]]
} }
} }
data_callback_del { data_callback_del {
/*@ [[Function to delete the @data_callback.]]
* Function to delete the @data_callback.
*/
params { params {
name: const (char) *; /*@ The name of the eet stream. */ name: const (char) *; [[The name of the eet stream.]]
} }
} }
raw_data_callback_del { raw_data_callback_del {
/*@ [[Function to delete the @raw_data_callback.]]
* Function to delete the @raw_data_callback.
*/
params { params {
name: const (char) *; /*@ The name of the eet stream. */ name: const (char) *; [[The name of the eet stream.]]
} }
} }
register { register {
/*@ [[Function to register a @Eet_Data_Descriptor to the
* Function to register a @Eet_Data_Descriptor to the ecore_con_eet object.]]
* ecore_con_eet object.
*/
legacy: ecore_con_eet; legacy: ecore_con_eet;
params { params {
name: const (char) *; /*@ The name of the eet stream. */ name: const (char) *; [[The name of the eet stream.]]
edd: Eet_Data_Descriptor *; /*@ The Eet_Data_Descriptor that edd: Eet_Data_Descriptor *; [[The Eet_Data_Descriptor that
* is to be registered. */ is to be registered.]]
} }
} }
send { send {
/*@ [[Function to send data.]]
* Function to send data.
*/
params { params {
reply: Ecore_Con_Reply *; /*@ Contains the ecore_con_eet object reply: Ecore_Con_Reply *; [[Contains the ecore_con_eet object
to which the data has to be sent. */ to which the data has to be sent.]]
name: const (char) *; /*@ The name of the eet stream. */ name: const (char) *; [[The name of the eet stream.]]
value: void *; /*@ Actual data */ value: void *; [[Actual data]]
} }
} }
raw_send { raw_send {
/*@ [[Function to send raw data.]]
* Function to send raw data.
*/
params { params {
reply: Ecore_Con_Reply *; /*@ Contains the ecore_con_eet object reply: Ecore_Con_Reply *; [[Contains the ecore_con_eet object
to which the data has to be sent. */ to which the data has to be sent.]]
protocol_name: const (char) *; /*@ The name of the eet stream. */ protocol_name: const (char) *; [[The name of the eet stream.]]
section: const (char) *; /*@ Name of section in the eet descriptor. */ section: const (char) *; [[Name of section in the eet descriptor.]]
value: void *; /*@ The value of the section. */ value: void *; [[The value of the section.]]
length: uint; /*@ The length of the data that is being sent. */ length: uint; [[The length of the data that is being sent.]]
} }
} }
} }