aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-03-28 15:33:28 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-03-28 15:34:27 +0100
commit6839c01669936198d413a754e6c48ecab459e4ce (patch)
tree294d0c36d31e70cf86dbc767f2267e2067bc2f0c
parentdocs: Fill-in parts docs for Efl.Ui.Grid_Default_Item (diff)
downloadefl-devs/xartigas/docs-todo-1.22.tar.gz
docs: Format efl_file.hdevs/xartigas/docs-todo-1.22
Summary: And polish a bit. Ref https://phab.enlightenment.org/T7717 Test Plan: Only docs updated Reviewers: zmike Subscribers: cedric, #reviewers, #committers Tags: #efl Maniphest Tasks: https://phab.enlightenment.org/T7717 Differential Revision: https://phab.enlightenment.org/D8498
-rw-r--r--src/lib/efl/interfaces/efl_file.eo34
1 files changed, 17 insertions, 17 deletions
diff --git a/src/lib/efl/interfaces/efl_file.eo b/src/lib/efl/interfaces/efl_file.eo
index 6711dfb579..cd71a50401 100644
--- a/src/lib/efl/interfaces/efl_file.eo
+++ b/src/lib/efl/interfaces/efl_file.eo
@@ -1,5 +1,4 @@
import eina_types;
-import efl_gfx_types;
mixin Efl.File requires Efl.Object {
[[Efl file interface
@@ -10,23 +9,21 @@ mixin Efl.File requires Efl.Object {
@property mmap {
set {
[[Set the mmaped file from where an object will fetch the real
- data (it must be an Eina_File).
+ data (it must be an @Eina.File).
If mmap is set during object construction, the object will automatically
call @.load during the finalize phase of construction.
-
- ]]
+ ]]
return: Eina.Error; [[0 on success, error code otherwise]]
}
get {
[[Get the mmaped file from where an object will fetch the real
- data (it must be an Eina_File).
-
- ]]
+ data (it must be an @Eina.File).
+ ]]
}
values {
- f: ptr(const(Eina.File)); [[The handle to an Eina_File that will be used]]
+ f: ptr(const(Eina.File)); [[The handle to the @Eina.File that will be used]]
}
}
@property file {
@@ -42,7 +39,8 @@ mixin Efl.File requires Efl.Object {
get {
[[Retrieve the file path from where an object is to fetch the data.
- You must not modify the strings on the returned pointers.]]
+ You must not modify the strings on the returned pointers.
+ ]]
}
values {
file: string; [[The file path.]]
@@ -62,13 +60,14 @@ mixin Efl.File requires Efl.Object {
Some filetypes can contain multiple data streams which are indexed by
a key. Use this property for such cases.
- You must not modify the strings on the returned pointers.]]
+ You must not modify the strings on the returned pointers.
+ ]]
}
values {
- key: string; [[The group that the image belongs to, in case
- it's an EET(including Edje case) file. This can be used
- as a key inside evas image cache if this is a normal image
- file not eet file.]]
+ key: string; [[The group that the data belongs to, in case it's an EET file
+ (including Edje files). This can also be used as a key inside
+ an evas image cache if this is a normal image file.
+ ]]
}
}
@property loaded {
@@ -77,7 +76,7 @@ mixin Efl.File requires Efl.Object {
]]
}
values {
- loaded: bool; [[True if the object is loaded, otherwise false.]]
+ loaded: bool; [[$true if the object is loaded, $false otherwise.]]
}
}
@@ -89,9 +88,10 @@ mixin Efl.File requires Efl.Object {
open the file and call @.mmap.set on the object using the opened file handle.
Calling @.load on an object which has already performed file operations based on
- the currently set properties will have no effect.]]
+ the currently set properties will have no effect.
+ ]]
- return: Eina.Error; [[0 on success, error code otherwise]]
+ return: Eina.Error; [[0 on success, error code otherwise]]
}
unload {