summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-11-07 15:53:35 +0100
committerStefan Schmidt <stefan@osg.samsung.com>2016-11-07 15:53:35 +0100
commita67041843148c2c8655c2192fe5951ff7dd7b0bd (patch)
tree6a649db4fd33c55466bc2077e8b534d5932e698f
parent095c8d2484a191b87d84394ada95a20f74232c2b (diff)
downloadefl-a67041843148c2c8655c2192fe5951ff7dd7b0bd.tar.gz
docs: efl_io: add missing docs for efl_io_manager
-rw-r--r--src/lib/eio/efl_io_manager.eo32
1 files changed, 16 insertions, 16 deletions
diff --git a/src/lib/eio/efl_io_manager.eo b/src/lib/eio/efl_io_manager.eo
index d0ac5c56aa..94c72bc233 100644
--- a/src/lib/eio/efl_io_manager.eo
+++ b/src/lib/eio/efl_io_manager.eo
@@ -15,44 +15,44 @@ class Efl.Io.Manager (Efl.Loop_User)
ls {
[[Lists entries in a given path.]]
params {
- @in path: string;
+ @in path: string; [[Path we want to list entries for]]
}
- return: future<uint64, const(array<string>)>;
+ return: future<uint64, const(array<string>)>; [[List of entries in path]]
}
direct_ls {
[[Lists entries in a given path with more information.]]
params {
- @in path: string;
- @in recursive: bool;
+ @in path: string;[[Path we want to list entries for]]
+ @in recursive: bool; [[If $true, list entries recursively, $false otherwise]]
}
- return: future<uint64, const(array<Eina_File_Direct_Info>)>;
+ return: future<uint64, const(array<Eina_File_Direct_Info>)>; [[List of entries in path]]
}
stat_ls {
[[Lists entries in a given path with stat information.]]
params {
- @in path: string;
- @in recursive: bool;
+ @in path: string;[[Path we want to list entries for]]
+ @in recursive: bool; [[If $true, list entries recursively, $false otherwise]]
}
- return: future<uint64, const(array<Eina_File_Direct_Info>)>;
+ return: future<uint64, const(array<Eina_File_Direct_Info>)>; [[List of entries in path]]
}
// Extended attributes
xattr_ls {
[[Lists all extended attributes asynchronously.]]
params {
- @in path: string;
+ @in path: string;[[Path we want to list entries for]]
}
- return: future<uint64, const(array<string>)>;
+ return: future<uint64, const(array<string>)>; [[Extended attributes]]
}
stat {
[[Get stat info on a given file/directory.]]
params {
- @in path: string;
+ @in path: string; [[Path we want to get stat information for]]
}
- return: future<Eina_Stat>;
+ return: future<Eina_Stat>; [[Stat information]]
}
// FIXME: Add helper for Eina.Value to Xattr
@@ -80,15 +80,15 @@ class Efl.Io.Manager (Efl.Loop_User)
The fulfilled value in the promise will be the Eina.File*.]]
params {
- @in path: string;
- @in shared: bool;
+ @in path: string; [[Path to file]]
+ @in shared: bool; [[$true if the file can be accessed by others, $false otherwise]]
}
- return: future<Eina.File>;
+ return: future<Eina.File>; [[Eina file handle]]
}
close {
[[Closes an open Eina.File.]]
params {
- @in file: ptr(Eina.File);
+ @in file: ptr(Eina.File); [[Eina file handle]]
// Here we're just interested whether the promise was fullfilled or not. No value needed.
}
return: future<int>;