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

docs: ecore: finish up eo file docs in ecore

This commit is contained in:
Stefan Schmidt 2016-11-11 10:58:22 +01:00
parent e056e0b1d1
commit 6a322b1b2c
13 changed files with 36 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib/ecore/ecore_exe.eo
View File

@ -15,9 +15,9 @@ struct Ecore.Exe.Event_Data
{
[[Ecore exe event data structure]]
exe: Efl.Object; [[The handle to the process. FIXME: should actually be Ecore.Exe, workaround cyclic]]
data: void_ptr; [[the raw binary data from the child process that was received]]
size: int; [[the size of this data in bytes]]
lines: ptr(Ecore.Exe.Event_Data.Line); [[an array of line data if line buffered, the last one has it's line member set to $NULL]]
data: void_ptr; [[The raw binary data from the child process that was received]]
size: int; [[The size of this data in bytes]]
lines: ptr(Ecore.Exe.Event_Data.Line); [[An array of line data if line buffered, the last one has it's line member set to $NULL]]
}
enum Ecore.Exe_Flags

3
src/lib/ecore/efl_io_closer_fd.eo
View File

@ -6,10 +6,11 @@ mixin Efl.Io.Closer.Fd (Efl.Io.Closer) {
methods {
@property closer_fd {
[[Closer file descriptor]]
get {}
set @protected {}
values {
fd: int;
fd: int; [[File descriptor]]
}
}
}

11
src/lib/ecore/efl_io_copier.eo
View File

@ -30,7 +30,7 @@ class Efl.Io.Copier (Efl.Loop_User, Efl.Io.Closer) {
[[Constructor-only property to set where to read data from]]
}
values {
source: Efl.Io.Reader;
source: Efl.Io.Reader; [[Reader source]]
}
}
@ -41,7 +41,7 @@ class Efl.Io.Copier (Efl.Loop_User, Efl.Io.Closer) {
[[Constructor-only property to set where to write data to]]
}
values {
destination: Efl.Io.Writer;
destination: Efl.Io.Writer; [[Writer destination]]
}
}
@ -79,11 +79,12 @@ class Efl.Io.Copier (Efl.Loop_User, Efl.Io.Closer) {
}
@property progress {
[[Progress for read or write]]
get {
}
values {
read: uint64 @optional; [[amount of bytes read from source]]
written: uint64 @optional; [[amount of bytes written to destination]]
read: uint64 @optional; [[Amount of bytes read from source]]
written: uint64 @optional; [[Amount of bytes written to destination]]
total: uint64 @optional; [[If @.source is an Efl.Io.Sizer, its total size. Otherwise 0 to report unknown size]]
}
}
@ -109,7 +110,7 @@ class Efl.Io.Copier (Efl.Loop_User, Efl.Io.Closer) {
The buffer is then owned by caller, which should call
eina_binbuf_free() when it's done.
]]
return: free(own(ptr(Eina.Binbuf)), eina_binbuf_free) @warn_unused;
return: free(own(ptr(Eina.Binbuf)), eina_binbuf_free) @warn_unused; [[Binbuf]]
}
}

10
src/lib/ecore/efl_io_file.eo
View File

@ -10,7 +10,7 @@ class Efl.Io.File (Efl.Loop.Fd, Efl.File, Efl.Io.Reader.Fd, Efl.Io.Writer.Fd, Ef
methods {
@property flags {
[[bitwise OR'ed flags to open the file, like O_CREAT, O_APPEND...
[[Bitwise OR'ed flags to open the file, like O_CREAT, O_APPEND...
Defaults to O_RDONLY | O_CLOEXEC.
@ -23,11 +23,11 @@ class Efl.Io.File (Efl.Loop.Fd, Efl.File, Efl.Io.Reader.Fd, Efl.Io.Writer.Fd, Ef
}
set {
[[constructor property to define flags to open the file]]
[[Constructor property to define flags to open the file]]
}
values {
flags: uint32; [[flags to open file, see man:open(2).]]
flags: uint32; [[Flags to open file, see man:open(2).]]
}
}
@ -36,11 +36,11 @@ class Efl.Io.File (Efl.Loop.Fd, Efl.File, Efl.Io.Reader.Fd, Efl.Io.Writer.Fd, Ef
}
set {
[[constructor property to define mode to open the file]]
[[Constructor property to define mode to open the file]]
}
values {
mode: uint32; [[mode to open file, see man:open(2).]]
mode: uint32; [[Mode to open file, see man:open(2).]]
}
}
}

3
src/lib/ecore/efl_io_positioner_fd.eo
View File

@ -6,10 +6,11 @@ mixin Efl.Io.Positioner.Fd (Efl.Io.Positioner) {
methods {
@property positioner_fd {
[[Positionier file descriptor]]
get {}
set @protected {}
values {
fd: int;
fd: int; [[File descriptor]]
}
}
}

3
src/lib/ecore/efl_io_reader_fd.eo
View File

@ -6,10 +6,11 @@ mixin Efl.Io.Reader.Fd (Efl.Io.Reader) {
methods {
@property reader_fd {
[[Reader file descriptor]]
get {}
set @protected {}
values {
fd: int;
fd: int; [[File descriptor]]
}
}
}

3
src/lib/ecore/efl_io_sizer_fd.eo
View File

@ -6,10 +6,11 @@ mixin Efl.Io.Sizer.Fd (Efl.Io.Sizer) {
methods {
@property sizer_fd {
[[Sizer file descriptor]]
get {}
set @protected {}
values {
fd: int;
fd: int; [[File descriptor]]
}
}
}

3
src/lib/ecore/efl_io_writer_fd.eo
View File

@ -6,10 +6,11 @@ mixin Efl.Io.Writer.Fd (Efl.Io.Writer) {
methods {
@property writer_fd {
[[Writer file descriptor]]
get {}
set @protected {}
values {
fd: int;
fd: int; [[File descriptor]]
}
}
}

8
src/lib/ecore/efl_loop.eo
View File

@ -23,7 +23,7 @@ class Efl.Loop (Efl.Object)
[[Points to the main loop instance of the application.]]
get {}
values {
main_loop: Efl.Loop;
main_loop: Efl.Loop; [[Application main loop]]
}
}
@property app_efl_version {
@ -33,7 +33,7 @@ class Efl.Loop (Efl.Object)
]]
get {}
values {
version: ptr(const(Efl.Version));
version: ptr(const(Efl.Version)); [[Efl version]]
}
}
@property efl_version {
@ -43,7 +43,7 @@ class Efl.Loop (Efl.Object)
]]
get {}
values {
version: ptr(const(Efl.Version));
version: ptr(const(Efl.Version)); [[Efl version]]
}
}
iterate {
@ -53,7 +53,7 @@ class Efl.Loop (Efl.Object)
iterate_may_block {
[[Runs a single iteration of the main loop to process everything on the
queue with block/non-blocking status.]]
return: int;
return: int; [[Return from single iteration run]]
params {
may_block: int; [[A flag if the main loop has a possibility of blocking.]]
}

6
src/lib/ecore/efl_loop_fd.eo
View File

@ -34,9 +34,9 @@ class Efl.Loop.Fd (Efl.Loop_User)
}
}
events {
read;
write;
error;
read; [[Called when a read happened on the file descriptor]]
write; [[Called when a write happened on the file descriptor]]
error; [[Called when a error occurred on the file descriptor]]
}
implements {
Efl.Object.constructor;

2
src/lib/ecore/efl_loop_timer.eo
View File

@ -25,7 +25,7 @@ class Efl.Loop.Timer (Efl.Loop_User)
@property pending {
[[Pending time regarding a timer.]]
get {
return: double;
return: double; [[Pending time]]
}
}
reset {

3
src/lib/ecore/efl_loop_user.eo
View File

@ -6,7 +6,8 @@ class Efl.Loop_User (Efl.Object)
eo_prefix: efl_loop;
methods {
loop_get {
return: Efl.Loop;
[[Get loop]]
return: Efl.Loop; [[Efl loop]]
}
}
implements {

3
src/lib/ecore/efl_promise.eo
View File

@ -2,6 +2,7 @@ import eina_types;
class Efl.Promise (Efl.Loop_User)
{
[[Efl promise class]]
methods {
progress_set {
[[Update the progress and send it immediately to all connected Efl_Future.
@ -11,7 +12,7 @@ class Efl.Promise (Efl.Loop_User)
of the function call.
]]
params {
@in p: const(void_ptr);
@in p: const(void_ptr); [[Progress to be set]]
}
}
@property future {