summaryrefslogtreecommitdiff
path: root/efl/emotion
diff options
context:
space:
mode:
authorDave Andreoli <dave@gurumeditation.it>2015-01-03 20:17:24 +0100
committerDave Andreoli <dave@gurumeditation.it>2015-01-03 20:17:24 +0100
commit6ff99982587c8e44b84bd384eb06ab28e6b558cf (patch)
tree26d2297aa3371e46bff846d5b3bde67ee0c7ca00 /efl/emotion
parent64c1d33c9f69ec43e342337cb06920b83781cb86 (diff)
Lots of documentation fixes for ALL the classes
Mainly with regard of class __init__ params and the **keyword param
Diffstat (limited to 'efl/emotion')
-rw-r--r--efl/emotion/efl.emotion.pyx25
1 files changed, 13 insertions, 12 deletions
diff --git a/efl/emotion/efl.emotion.pyx b/efl/emotion/efl.emotion.pyx
index 8cf66cb..5162891 100644
--- a/efl/emotion/efl.emotion.pyx
+++ b/efl/emotion/efl.emotion.pyx
@@ -180,17 +180,7 @@ cdef class Emotion(evasObject):
180 180
181 The Emotion object 181 The Emotion object
182 182
183 :see: :py:mod:`The documentation page<efl.emotion>` 183 .. seealso:: :py:mod:`The documentation page<efl.emotion>`
184
185 :param evas: The canvas where the object will be added to.
186 :type evas: efl.evas.Canvas
187 :param module_name: name of the engine to use (gstreamer, xine, vlc or generic)
188 :param module_params: Extra parameters, module specific
189 :param size: (w, h)
190 :param pos: (x, y)
191 :param geometry: (x, y, w, h)
192 :param color: (r, g, b, a)
193 :return: The emotion object instance just created.
194 184
195 .. versionchanged:: 1.8 185 .. versionchanged:: 1.8
196 Keyword argument module_filename was renamed to module_name. 186 Keyword argument module_filename was renamed to module_name.
@@ -200,7 +190,18 @@ cdef class Emotion(evasObject):
200 self._emotion_callbacks = {} 190 self._emotion_callbacks = {}
201 191
202 def __init__(self, Canvas canvas not None, module_name="gstreamer", 192 def __init__(self, Canvas canvas not None, module_name="gstreamer",
203 module_params=None, **kwargs): 193 module_params=None, **kwargs):
194 """Emotion(...)
195
196 :param canvas: Evas canvas for this object
197 :type canvas: :py:class:`~efl.evas.Canvas`
198 :keyword module_name: name of the engine to use
199 :type module_name: string
200 :keyword module_params: Extra parameters, module specific
201 :keyword \**kwargs: All the remaining keyword arguments are interpreted
202 as properties of the instance
203
204 """
204 205
205 self._set_obj(emotion_object_add(canvas.obj)) 206 self._set_obj(emotion_object_add(canvas.obj))
206 _register_decorated_callbacks(self) 207 _register_decorated_callbacks(self)