forked from enlightenment/efl
plug: convert docs
This commit is contained in:
parent
73223214fb
commit
a07c213e59
|
@ -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
|
||||
Note: Be careful to not manipulate it, as it is under control of
|
||||
elementary.
|
||||
|
||||
@ingroup Plug */
|
||||
return: Evas.Object *;
|
||||
]]
|
||||
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).]]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue