stefan pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=124effc5244658b05b5df6f6265cb0aa4297a119
commit 124effc5244658b05b5df6f6265cb0aa4297a119
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date: Fri Nov 11 09:15:24 2016 +0100
docs: eio: finish up missing eo file docs in eio
---
src/lib/eio/efl_io_manager.eo | 16 ++++++++--------
src/lib/eio/eio_sentry.eo | 28 ++++++++++++++--------------
2 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/src/lib/eio/efl_io_manager.eo b/src/lib/eio/efl_io_manager.eo
index 94c72bc..25756fa 100644
--- a/src/lib/eio/efl_io_manager.eo
+++ b/src/lib/eio/efl_io_manager.eo
@@ -42,7 +42,7 @@ class Efl.Io.Manager (Efl.Loop_User)
xattr_ls {
[[Lists all extended attributes asynchronously.]]
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]]
}
@@ -60,17 +60,17 @@ class Efl.Io.Manager (Efl.Loop_User)
[[Retrieves or sets information of a given extended attribute.]]
set {
values {
- data: ptr(Eina.Binbuf);
- flags: Eina.Xattr.Flags;
+ data: ptr(Eina.Binbuf); [[Data to set as information]]
+ flags: Eina.Xattr.Flags; [[Extended attributes flags]]
}
- return: future<uint64>;
+ return: future<uint64>; [[Future for asynchronous set operation]]
}
get {
- return: future<Eina.Binbuf>;
+ return: future<Eina.Binbuf>; [[Information]]
}
keys {
- path: string;
- attribute: string;
+ path: string; [[File path]]
+ attribute: string; [[Attribute name]]
}
}
@@ -91,7 +91,7 @@ class Efl.Io.Manager (Efl.Loop_User)
@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>;
+ return: future<int>; [[Close return code]]
}
}
}
diff --git a/src/lib/eio/eio_sentry.eo b/src/lib/eio/eio_sentry.eo
index 8948358..9f2add7 100644
--- a/src/lib/eio/eio_sentry.eo
+++ b/src/lib/eio/eio_sentry.eo
@@ -15,29 +15,29 @@ class Eio.Sentry (Efl.Object)
add {
[[Adds a new path to the list of monitored paths.]]
params {
- @in path: string;
+ @in path: string; [[Path to monitor]]
}
- return : bool;
+ return : bool; [[$true on success, $false otherwise]]
}
del {
[[Removes the given path from the monitored list.]]
params {
- @in path: string;
+ @in path: string; [[Path to remove from monitoring]]
}
}
}
events {
- file,created: Eio.Sentry.Event;
- file,deleted: Eio.Sentry.Event;
- file,modified: Eio.Sentry.Event;
- file,closed: Eio.Sentry.Event;
- directory,created: Eio.Sentry.Event;
- directory,deleted: Eio.Sentry.Event;
- directory,modified: Eio.Sentry.Event;
- directory,closed: Eio.Sentry.Event;
- self,rename: Eio.Sentry.Event;
- self,deleted: Eio.Sentry.Event;
- error: Eio.Sentry.Event;
+ file,created: Eio.Sentry.Event; [[Called when a file was created]]
+ file,deleted: Eio.Sentry.Event; [[Called when a file was deleted]]
+ file,modified: Eio.Sentry.Event; [[Called when a file was modified]]
+ file,closed: Eio.Sentry.Event; [[Called when a file was closed]]
+ directory,created: Eio.Sentry.Event; [[Called when a directory was
created]]
+ directory,deleted: Eio.Sentry.Event; [[Called when a directory was
deleted]]
+ directory,modified: Eio.Sentry.Event; [[called when a directory was
modified]]
+ directory,closed: Eio.Sentry.Event; [[Called when a directory was closed]]
+ self,rename: Eio.Sentry.Event; [[Called when the object was renamed]]
+ self,deleted: Eio.Sentry.Event; [[Called when the object was deleted]]
+ error: Eio.Sentry.Event; [[Called in case of an error]]
}
implements {
--
