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

plug: convert docs

This commit is contained in:
Daniel Kolesa 2015-07-31 15:14:34 +01:00
parent 73223214fb
commit a07c213e59
1 changed files with 13 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
legacy/elementary/src/lib/elm_plug.eo
View File

@ -5,35 +5,25 @@ class Elm.Plug (Elm.Widget, Evas.Clickable_Interface)
methods { methods {
@property image_object { @property image_object {
get { 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 Note: Be careful to not manipulate it, as it is under control of
Image from this elementary widget. It can be useful to do things like get elementary.
the pixel data, save the image to a file, etc. ]]
return: Evas.Object *; [[The inlined image object or $null.]]
@note Be careful to not manipulate it, as it is under control of
elementary.
@ingroup Plug */
return: Evas.Object *;
} }
} }
connect { connect {
/*@ [[Connect a plug widget to service provided by socket image.]]
Connect a plug widget to service provided by socket image. return: bool; [[$true on success, $false on error.]]
@return (@c EINA_TRUE = success, @c EINA_FALSE = error)
@ingroup Plug */
return: bool;
params { params {
@in svcname: const(char)*; /*@ The service name to connect to set up by the 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 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 svcsys: bool; [[Boolean to set if the service is a system one or not (set up by socket).]]
} }
} }
} }