q66 pushed a commit to branch master.
http://git.enlightenment.org/core/elementary.git/commit/?id=371d362efda82274e828a28229075409ee5caea9
commit 371d362efda82274e828a28229075409ee5caea9
Author: Daniel Kolesa <d.kol...@osg.samsung.com>
Date: Fri Jul 31 15:14:34 2015 +0100
plug: convert docs
---
src/lib/elm_plug.eo | 36 +++++++++++++-----------------------
1 file changed, 13 insertions(+), 23 deletions(-)
diff --git a/src/lib/elm_plug.eo b/src/lib/elm_plug.eo
index b89be97..3fe1af3 100644
--- a/src/lib/elm_plug.eo
+++ b/src/lib/elm_plug.eo
@@ -5,35 +5,25 @@ class Elm.Plug (Elm.Widget, Evas.Clickable_Interface)
methods {
@property image_object {
get {
- /*@
- Get the basic Evas_Image object from this object (widget).
+ [[Get the basic Evas_Image object from this object (widget).
- @return The inlined image object, or NULL if none exists
+ This function allows one to get the underlying Evas object of
type
+ Image from this elementary widget. It can be useful to do things
+ like get the pixel data, save the image to a file, etc.
- This function allows one to get the underlying @c Evas_Object of
type
- Image from this elementary widget. It can be useful to do things
like get
- the pixel data, save the image to a file, etc.
-
- @note Be careful to not manipulate it, as it is under control of
- elementary.
-
- @ingroup Plug */
- return: Evas.Object *;
+ Note: Be careful to not manipulate it, as it is under control of
+ elementary.
+ ]]
+ return: Evas.Object *; [[The inlined image object or $null.]]
}
}
connect {
- /*@
- Connect a plug widget to service provided by socket image.
-
- @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
-
- @ingroup Plug */
-
- return: bool;
+ [[Connect a plug widget to service provided by socket image.]]
+ return: bool; [[$true on success, $false on error.]]
params {
- @in svcname: const(char)*; /*@ The service name to connect to set
up by the socket. */
- @in svcnum: int; /*@ The service number to connect to (set up by
socket). */
- @in svcsys: bool; /*@ Boolean to set if the service is a system
one or not (set up by socket). */
+ @in svcname: const(char)*; [[The service name to connect to set up
by the socket.]]
+ @in svcnum: int; [[The service number to connect to (set up by
socket).]]
+ @in svcsys: bool; [[Boolean to set if the service is a system one
or not (set up by socket).]]
}
}
}
--
