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

docs: eio: finish up missing eo file docs in eio

This commit is contained in:
Stefan Schmidt 2016-11-11 09:15:24 +01:00
parent c588d49caa
commit 124effc524
2 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/lib/eio/efl_io_manager.eo
View File

@ -42,7 +42,7 @@ class Efl.Io.Manager (Efl.Loop_User)
xattr_ls { xattr_ls {
[[Lists all extended attributes asynchronously.]] [[Lists all extended attributes asynchronously.]]
params { params {
@in path: string;[[Path we want to list entries for]] @in path: string; [[Path we want to list entries for]]
} }
return: future<uint64, const(array<string>)>; [[Extended attributes]] return: future<uint64, const(array<string>)>; [[Extended attributes]]
} }
@ -60,17 +60,17 @@ class Efl.Io.Manager (Efl.Loop_User)
[[Retrieves or sets information of a given extended attribute.]] [[Retrieves or sets information of a given extended attribute.]]
set { set {
values { values {
data: ptr(Eina.Binbuf); data: ptr(Eina.Binbuf); [[Data to set as information]]
flags: Eina.Xattr.Flags; flags: Eina.Xattr.Flags; [[Extended attributes flags]]
} }
return: future<uint64>; return: future<uint64>; [[Future for asynchronous set operation]]
} }
get { get {
return: future<Eina.Binbuf>; return: future<Eina.Binbuf>; [[Information]]
} }
keys { keys {
path: string; path: string; [[File path]]
attribute: string; attribute: string; [[Attribute name]]
} }
} }
@ -91,7 +91,7 @@ class Efl.Io.Manager (Efl.Loop_User)
@in file: ptr(Eina.File); [[Eina file handle]] @in file: ptr(Eina.File); [[Eina file handle]]
// Here we're just interested whether the promise was fullfilled or not. No value needed. // Here we're just interested whether the promise was fullfilled or not. No value needed.
} }
return: future<int>; return: future<int>; [[Close return code]]
} }
} }
} }

28
src/lib/eio/eio_sentry.eo
View File

@ -15,29 +15,29 @@ class Eio.Sentry (Efl.Object)
add { add {
[[Adds a new path to the list of monitored paths.]] [[Adds a new path to the list of monitored paths.]]
params { params {
@in path: string; @in path: string; [[Path to monitor]]
} }
return : bool; return : bool; [[$true on success, $false otherwise]]
} }
del { del {
[[Removes the given path from the monitored list.]] [[Removes the given path from the monitored list.]]
params { params {
@in path: string; @in path: string; [[Path to remove from monitoring]]
} }
} }
} }
events { events {
file,created: Eio.Sentry.Event; file,created: Eio.Sentry.Event; [[Called when a file was created]]
file,deleted: Eio.Sentry.Event; file,deleted: Eio.Sentry.Event; [[Called when a file was deleted]]
file,modified: Eio.Sentry.Event; file,modified: Eio.Sentry.Event; [[Called when a file was modified]]
file,closed: Eio.Sentry.Event; file,closed: Eio.Sentry.Event; [[Called when a file was closed]]
directory,created: Eio.Sentry.Event; directory,created: Eio.Sentry.Event; [[Called when a directory was created]]
directory,deleted: Eio.Sentry.Event; directory,deleted: Eio.Sentry.Event; [[Called when a directory was deleted]]
directory,modified: Eio.Sentry.Event; directory,modified: Eio.Sentry.Event; [[called when a directory was modified]]
directory,closed: Eio.Sentry.Event; directory,closed: Eio.Sentry.Event; [[Called when a directory was closed]]
self,rename: Eio.Sentry.Event; self,rename: Eio.Sentry.Event; [[Called when the object was renamed]]
self,deleted: Eio.Sentry.Event; self,deleted: Eio.Sentry.Event; [[Called when the object was deleted]]
error: Eio.Sentry.Event; error: Eio.Sentry.Event; [[Called in case of an error]]
} }
implements { implements {