stefan pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=23811109646857d15438ea1239db141415472107
commit 23811109646857d15438ea1239db141415472107
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date: Tue Nov 1 14:13:42 2016 +0100
docs: efl_io: add missing docs for efl_io_* interfaces
---
src/lib/efl/interfaces/efl_io_buffer.eo | 10 +++++-----
src/lib/efl/interfaces/efl_io_closer.eo | 8 ++++----
src/lib/efl/interfaces/efl_io_positioner.eo | 2 +-
src/lib/efl/interfaces/efl_io_reader.eo | 7 ++++---
src/lib/efl/interfaces/efl_io_sizer.eo | 4 ++--
src/lib/efl/interfaces/efl_io_writer.eo | 7 ++++---
6 files changed, 20 insertions(+), 18 deletions(-)
diff --git a/src/lib/efl/interfaces/efl_io_buffer.eo
b/src/lib/efl/interfaces/efl_io_buffer.eo
index 5c0423d..10672d2 100644
--- a/src/lib/efl/interfaces/efl_io_buffer.eo
+++ b/src/lib/efl/interfaces/efl_io_buffer.eo
@@ -18,7 +18,7 @@ class Efl.Io.Buffer (Efl.Object, Efl.Io.Reader,
Efl.Io.Writer, Efl.Io.Closer, Ef
preallocate {
[[Immediately pre-allocate a buffer of at least a given size.]]
params {
- @in size: size; [[amount of bytes to pre-allocate.]]
+ @in size: size; [[Amount of bytes to pre-allocate.]]
}
}
@@ -52,10 +52,10 @@ class Efl.Io.Buffer (Efl.Object, Efl.Io.Reader,
Efl.Io.Writer, Efl.Io.Closer, Ef
]]
get { }
set {
- return: bool (false);
+ return: bool (false); [[$true if setting the position
succeeded, $false otherwise]]
}
values {
- position: uint64;
+ position: uint64; [[Position in buffer]]
}
}
@@ -71,10 +71,10 @@ class Efl.Io.Buffer (Efl.Object, Efl.Io.Reader,
Efl.Io.Writer, Efl.Io.Closer, Ef
]]
get { }
set {
- return: bool (false);
+ return: bool (false); [[$true if setting the position
succeeded, $false otherwise]]
}
values {
- position: uint64;
+ position: uint64; [[Position in buffer]]
}
}
diff --git a/src/lib/efl/interfaces/efl_io_closer.eo
b/src/lib/efl/interfaces/efl_io_closer.eo
index d54dff6..7ecfd7f 100644
--- a/src/lib/efl/interfaces/efl_io_closer.eo
+++ b/src/lib/efl/interfaces/efl_io_closer.eo
@@ -38,7 +38,7 @@ mixin Efl.Io.Closer {
return: bool; [[$true if could close, $false if already closed
or errors.]]
}
values {
- is_closed: bool;
+ is_closed: bool; [[$true if closed, $false otherwise]]
}
}
@@ -51,11 +51,11 @@ mixin Efl.Io.Closer {
]]
get @virtual_pure { }
set @virtual_pure {
- [[If true, will close on exec() call.]]
+ [[If $true, will close on exec() call.]]
return: bool; [[$true if could set, $false if not supported or
failed.]]
}
values {
- close_on_exec: bool;
+ close_on_exec: bool; [[$true if close on exec(), $false
otherwise]]
}
}
@@ -68,7 +68,7 @@ mixin Efl.Io.Closer {
get @virtual_pure { }
set @virtual_pure { }
values {
- close_on_destructor: bool;
+ close_on_destructor: bool; [[$true if close on destructor,
$false otherwise]]
}
}
}
diff --git a/src/lib/efl/interfaces/efl_io_positioner.eo
b/src/lib/efl/interfaces/efl_io_positioner.eo
index 7e4c791..9e17f22 100644
--- a/src/lib/efl/interfaces/efl_io_positioner.eo
+++ b/src/lib/efl/interfaces/efl_io_positioner.eo
@@ -31,7 +31,7 @@ mixin Efl.Io.Positioner {
return: bool; [[$true if could reposition, $false if errors.]]
}
values {
- position: uint64;
+ position: uint64; [[Position in file or buffer]]
}
}
}
diff --git a/src/lib/efl/interfaces/efl_io_reader.eo
b/src/lib/efl/interfaces/efl_io_reader.eo
index 79e78a3..1b3cc6d 100644
--- a/src/lib/efl/interfaces/efl_io_reader.eo
+++ b/src/lib/efl/interfaces/efl_io_reader.eo
@@ -29,7 +29,7 @@ interface Efl.Io.Reader {
You can understand this method as read(2) libc function.
]]
params {
- @inout rw_slice: Eina.Rw_Slice @nonull; [[provides a
pre-allocated memory to be filled up to rw_slice.len. It will be populated and
the length will be set to the actually used amount of bytes, which can be
smaller than the request.]]
+ @inout rw_slice: Eina.Rw_Slice @nonull; [[Provides a
pre-allocated memory to be filled up to rw_slice.len. It will be populated and
the length will be set to the actually used amount of bytes, which can be
smaller than the request.]]
}
return: Eina.Error; [[0 on succeed, a mapping of errno otherwise]]
}
@@ -39,7 +39,8 @@ interface Efl.Io.Reader {
get { }
set @protected { }
values {
- can_read: bool;
+ can_read: bool; [[$true if it can be read without blocking or
failing, $false
+ otherwise]]
}
}
@@ -48,7 +49,7 @@ interface Efl.Io.Reader {
get { }
set @protected { }
values {
- is_eos: bool;
+ is_eos: bool; [[$true if end of stream, $false otherwise]]
}
}
}
diff --git a/src/lib/efl/interfaces/efl_io_sizer.eo
b/src/lib/efl/interfaces/efl_io_sizer.eo
index 2b104f1..97c0fa5 100644
--- a/src/lib/efl/interfaces/efl_io_sizer.eo
+++ b/src/lib/efl/interfaces/efl_io_sizer.eo
@@ -14,7 +14,7 @@ mixin Efl.Io.Sizer {
methods {
resize @virtual_pure {
params {
- @in size: uint64;
+ @in size: uint64; [[Object size]]
}
return: Eina.Error; [[0 on succeed, a mapping of errno otherwise]]
}
@@ -26,7 +26,7 @@ mixin Efl.Io.Sizer {
return: bool; [[$true if could resize, $false if errors.]]
}
values {
- size: uint64;
+ size: uint64; [[Object size]]
}
}
}
diff --git a/src/lib/efl/interfaces/efl_io_writer.eo
b/src/lib/efl/interfaces/efl_io_writer.eo
index f3a777c..77807c3 100644
--- a/src/lib/efl/interfaces/efl_io_writer.eo
+++ b/src/lib/efl/interfaces/efl_io_writer.eo
@@ -29,8 +29,8 @@ interface Efl.Io.Writer {
You can understand this method as write(2) libc function.
]]
params {
- @inout slice: Eina.Slice @nonull; [[provides a pre-populated
memory to be used up to slice.len. The returned slice will be adapted as length
will be set to the actually used amount of bytes, which can be smaller than the
request.]]
- @out remaining: Eina.Slice @optional; [[convenience to output
the remaining parts of slice that was not written. If the full slice was
written, this will be a slice of zero-length.]]
+ @inout slice: Eina.Slice @nonull; [[Provides a pre-populated
memory to be used up to slice.len. The returned slice will be adapted as length
will be set to the actually used amount of bytes, which can be smaller than the
request.]]
+ @out remaining: Eina.Slice @optional; [[Convenience to output
the remaining parts of slice that was not written. If the full slice was
written, this will be a slice of zero-length.]]
}
return: Eina.Error; [[0 on succeed, a mapping of errno otherwise]]
}
@@ -40,7 +40,8 @@ interface Efl.Io.Writer {
get { }
set @protected { }
values {
- can_write: bool;
+ can_write: bool; [[$true if it can be written without blocking
or failure, $false
+ otherwise]]
}
}
}
--
