davemds pushed a commit to branch master.
http://git.enlightenment.org/bindings/python/python-efl.git/commit/?id=5c3ced421cdcf26bd1c30f4fbccb8ada91b7f638
commit 5c3ced421cdcf26bd1c30f4fbccb8ada91b7f638
Author: davemds <d...@gurumeditation.it>
Date: Sun Apr 6 17:03:58 2014 +0200
docs: remove the signatures from the docstring, are now autimatically added
by cython
---
efl/ecore/efl.ecore_animator.pxi | 14 ++------
efl/ecore/efl.ecore_fd_handler.pxi | 6 ++--
efl/ecore/efl.ecore_file_download.pxi | 12 +++----
efl/ecore/efl.ecore_timer.pxi | 8 ++---
efl/edje/efl.edje_object.pxi | 14 +++-----
efl/emotion/efl.emotion.pyx | 8 ++---
efl/evas/efl.evas.pyx | 8 ++---
efl/evas/efl.evas_map.pxi | 63 +++++++++-------------------------
efl/evas/efl.evas_object.pxi | 41 +++++-----------------
efl/evas/efl.evas_object_grid.pxi | 16 +++------
efl/evas/efl.evas_object_image.pxi | 26 ++++----------
efl/evas/efl.evas_object_line.pxi | 4 +--
efl/evas/efl.evas_object_polygon.pxi | 4 +--
efl/evas/efl.evas_object_rectangle.pxi | 4 +--
efl/evas/efl.evas_object_smart.pxi | 4 +--
efl/evas/efl.evas_object_table.pxi | 24 ++++---------
efl/evas/efl.evas_object_text.pxi | 13 ++-----
efl/evas/efl.evas_object_textblock.pxi | 11 ++----
efl/evas/efl.evas_object_textgrid.pxi | 21 +++---------
efl/evas/efl.evas_rect.pxi | 36 +++++--------------
20 files changed, 83 insertions(+), 254 deletions(-)
diff --git a/efl/ecore/efl.ecore_animator.pxi b/efl/ecore/efl.ecore_animator.pxi
index 16ab916..4b5a6a3 100644
--- a/efl/ecore/efl.ecore_animator.pxi
+++ b/efl/ecore/efl.ecore_animator.pxi
@@ -17,10 +17,7 @@
cdef class Animator(Eo):
-
- """
-
- Creates an animator to tick off at every animaton tick during main loop
+ """Creates an animator to tick off at every animaton tick during main loop
execution.
This class represents an animator that will call the given ``func``
@@ -89,10 +86,7 @@ cdef Eina_Bool _ecore_timeline_cb(void *data, double pos)
with gil:
return ret
cdef class AnimatorTimeline(Animator):
-
- """
-
- Add an animator that runs for a limited time
+ """Add an animator that runs for a limited time
:param runtime: The time to run in seconds
:param func: The function to call when it ticks off
@@ -128,9 +122,7 @@ cdef class AnimatorTimeline(Animator):
return self.func(*self.args, **self.kargs)
def animator_add(func, *args, **kargs):
- """
-
- Animator factory, for C-api compatibility.
+ """Animator factory, for C-api compatibility.
func signature::
diff --git a/efl/ecore/efl.ecore_fd_handler.pxi
b/efl/ecore/efl.ecore_fd_handler.pxi
index f92bc01..2d950ba 100644
--- a/efl/ecore/efl.ecore_fd_handler.pxi
+++ b/efl/ecore/efl.ecore_fd_handler.pxi
@@ -199,8 +199,7 @@ cdef class FdHandler(object):
return bool(ecore_main_fd_handler_active_get(self.obj, ECORE_FD_ERROR))
def prepare_callback_set(self, func, *args, **kargs):
- """
- Set a function to call becore doing the select() on the fd.
+ """Set a function to call becore doing the select() on the fd.
Expected signature::
@@ -220,8 +219,7 @@ cdef class FdHandler(object):
def fd_handler_add(fd, int flags, func, *args, **kargs):
- """
- :py:class:`FdHandler` factory, for C-api compatibility.
+ """:py:class:`FdHandler` factory, for C-api compatibility.
``func`` signature::
diff --git a/efl/ecore/efl.ecore_file_download.pxi
b/efl/ecore/efl.ecore_file_download.pxi
index 125ebd5..3d0d7b7 100644
--- a/efl/ecore/efl.ecore_file_download.pxi
+++ b/efl/ecore/efl.ecore_file_download.pxi
@@ -138,8 +138,7 @@ cdef class FileDownload(object):
def file_download(url, dst, completion_cb, progress_cb, *args, **kargs):
- """
- efl.ecore.FileDownload} factory, for C-api compatibility.
+ """efl.ecore.FileDownload} factory, for C-api compatibility.
:param url: The complete url to download
:param dst: Where to download the file
@@ -156,21 +155,18 @@ def file_download(url, dst, completion_cb, progress_cb,
*args, **kargs):
return FileDownload(url, dst, completion_cb, progress_cb, *args, **kargs)
def file_download_abort(instance):
- """
- C-api compatibility
+ """C-api compatibility
Abort the given download an free internal resources
"""
instance.abort()
def file_download_abort_all():
- """
- This will abort all the download currently in progrss, use with caution.
+ """This will abort all the download currently in progrss, use with caution.
"""
ecore_file_download_abort_all()
def file_download_protocol_available(protocol):
- """
- Check if the given download protocol is available, available protocols
+ """Check if the given download protocol is available, available protocols
are: "http://";, "ftp://"; and "file://". Note that ecore can be
compiled without CURL support and thus http and ftp could not be available
diff --git a/efl/ecore/efl.ecore_timer.pxi b/efl/ecore/efl.ecore_timer.pxi
index f8fb570..4970935 100644
--- a/efl/ecore/efl.ecore_timer.pxi
+++ b/efl/ecore/efl.ecore_timer.pxi
@@ -82,9 +82,7 @@ cdef class Timer(Eo):
ecore_timer_thaw(self.obj)
def delay(self, double add):
- """delay(float add)
-
- Delay the execution of the timer by the given amount
+ """Delay the execution of the timer by the given amount
:param add: seconds to add to the timer
:type add: double
@@ -95,9 +93,7 @@ cdef class Timer(Eo):
ecore_timer_delay(self.obj, add)
def reset(self):
- """reset()
-
- Reset the counter of the timer
+ """Reset the counter of the timer
.. versionadded:: 1.8
diff --git a/efl/edje/efl.edje_object.pxi b/efl/edje/efl.edje_object.pxi
index a58cb01..d934685 100644
--- a/efl/edje/efl.edje_object.pxi
+++ b/efl/edje/efl.edje_object.pxi
@@ -345,9 +345,7 @@ cdef class Edje(Object):
size)
property scale:
- """
-
- The scaling factor for a given Edje object.
+ """The scaling factor for a given Edje object.
:type: float
@@ -366,9 +364,7 @@ cdef class Edje(Object):
return edje_object_scale_get(self.obj)
property mirrored:
- """
-
- The RTL orientation for this object.
+ """The RTL orientation for this object.
:type: int
@@ -439,8 +435,7 @@ cdef class Edje(Object):
return (w, h)
def parts_extends_calc(self):
- """
- Calculate the geometry of the region, relative to a given Edje
+ """Calculate the geometry of the region, relative to a given Edje
object's area, *occupied by all parts in the object*
:return: (x, y, w, h)
@@ -481,8 +476,7 @@ cdef class Edje(Object):
<const char *>part if part is not None else NULL))
def part_object_get(self, part):
- """
- Get the efl.evas.Object that represents this part.
+ """Get the efl.evas.Object that represents this part.
.. warning::
You should never modify the state of the returned object
diff --git a/efl/emotion/efl.emotion.pyx b/efl/emotion/efl.emotion.pyx
index b9f2c69..be3a697 100644
--- a/efl/emotion/efl.emotion.pyx
+++ b/efl/emotion/efl.emotion.pyx
@@ -131,9 +131,7 @@ def shutdown():
def webcams_get():
- """webcams_get() -> list
-
- Get a list of active and available webcam.
+ """Get a list of active and available webcam.
:return: the list of tuple (webcam name, webcam device)
@@ -159,9 +157,7 @@ def webcams_get():
return ret
def extension_may_play_get(filename):
- """extension_may_play_get(filename) -> bool
-
- Do we have a chance to play that file?
+ """Do we have a chance to play that file?
This just actually look at the extention of the file, it doesn't check
the mime-type nor if the file is actually sane. So this is just an
diff --git a/efl/evas/efl.evas.pyx b/efl/evas/efl.evas.pyx
index 4c088ce..0e25a48 100644
--- a/efl/evas/efl.evas.pyx
+++ b/efl/evas/efl.evas.pyx
@@ -172,9 +172,7 @@ def shutdown():
def render_method_lookup(name):
- """render_method_lookup(name)
-
- Lookup render method and return its id (> 0 if found).
+ """Lookup render method and return its id (> 0 if found).
:param name: Render method
:type name: string
@@ -187,9 +185,7 @@ def render_method_lookup(name):
def render_method_list():
- """render_method_list()
-
- Returns a list of render method names.
+ """Returns a list of render method names.
:rtype: list of str
diff --git a/efl/evas/efl.evas_map.pxi b/efl/evas/efl.evas_map.pxi
index a3de1eb..7af8f95 100644
--- a/efl/evas/efl.evas_map.pxi
+++ b/efl/evas/efl.evas_map.pxi
@@ -64,9 +64,7 @@ cdef class Map(object):
self.map = NULL
def util_points_populate_from_object_full(self, Object obj, Evas_Coord z):
- """util_points_populate_from_object_full(Object obj, Evas_Coord z)
-
- Populate source and destination map points to match exactly object.
+ """Populate source and destination map points to match exactly object.
Usually one initialize map of an object to match it's original
position and size, then transform these with evas_map_util_*
@@ -83,9 +81,7 @@ cdef class Map(object):
evas_map_util_points_populate_from_object_full(self.map, obj.obj, z)
def util_points_populate_from_object(self, Object obj):
- """util_points_populate_from_object(Object obj)
-
- Populate source and destination map points to match exactly object.
+ """Populate source and destination map points to match exactly object.
Usually one initialize map of an object to match it's original
position and size, then transform these with evas_map_util_*
@@ -101,9 +97,7 @@ cdef class Map(object):
evas_map_util_points_populate_from_object(self.map, obj.obj)
def util_points_populate_from_geometry(self, Evas_Coord x, Evas_Coord y,
Evas_Coord w, Evas_Coord h, Evas_Coord z):
- """util_points_populate_from_geometry(Evas_Coord x, Evas_Coord y,
Evas_Coord w, Evas_Coord h, Evas_Coord z)
-
- Populate source and destination map points to match given geometry.
+ """Populate source and destination map points to match given geometry.
Similar to evas_map_util_points_populate_from_object_full(), this
call takes raw values instead of querying object's unmapped
@@ -122,8 +116,7 @@ cdef class Map(object):
evas_map_util_points_populate_from_geometry(self.map, x, y, w, h, z)
def util_points_color_set(self, int r, int g, int b, int a):
- """util_points_color_set(int r, int g, int b, int a)
- Set color of all points to given color.
+ """Set color of all points to given color.
This call is useful to reuse maps after they had 3d lightning or
any other colorization applied before.
@@ -137,9 +130,7 @@ cdef class Map(object):
evas_map_util_points_color_set(self.map, r, g, b, a)
def util_rotate(self, double degrees, Evas_Coord cx, Evas_Coord cy):
- """util_rotate(double degrees, Evas_Coord cx, Evas_Coord cy)
-
- Change the map to apply the given rotation.
+ """Change the map to apply the given rotation.
This rotates the indicated map's coordinates around the center
coordinate
given by *cx* and *cy* as the rotation center. The points will have
their
@@ -155,9 +146,7 @@ cdef class Map(object):
evas_map_util_rotate(self.map, degrees, cx, cy)
def util_zoom(self, double zoomx, double zoomy, Evas_Coord cx, Evas_Coord
cy):
- """util_zoom(double zoomx, double zoomy, Evas_Coord cx, Evas_Coord cy)
-
- Change the map to apply the given zooming.
+ """Change the map to apply the given zooming.
Like evas_map_util_rotate(), this zooms the points of the map from a
center
point. That center is defined by *cx* and *cy*. The *zoomx* and *zoomy*
@@ -174,9 +163,7 @@ cdef class Map(object):
evas_map_util_zoom(self.map, zoomx, zoomy, cx, cy)
def util_3d_rotate(self, double dx, double dy, double dz, Evas_Coord cx,
Evas_Coord cy, Evas_Coord cz):
- """util_3d_rotate(double dx, double dy, double dz, Evas_Coord cx,
Evas_Coord cy, Evas_Coord cz)
-
- Rotate the map around 3 axes in 3D
+ """Rotate the map around 3 axes in 3D
This will rotate not just around the "Z" axis as in
evas_map_util_rotate()
(which is a convenience call for those only wanting 2D). This will
rotate
@@ -196,9 +183,7 @@ cdef class Map(object):
evas_map_util_3d_rotate(self.map, dx, dy, dz, cx, cy, cz)
def util_quat_rotate(self, double qx, double qy, double qz, double qw,
double cx, double cy, double cz):
- """util_quat_rotate(double qx, double qy, double qz, double qw, double
cx, double cy, double cz)
-
- Rotate the map in 3D using a unit quaternion.
+ """Rotate the map in 3D using a unit quaternion.
This will rotate in 3D using a unit quaternion. Like with
evas_map_util_3d_rotate() you provide a center point
@@ -220,9 +205,7 @@ cdef class Map(object):
evas_map_util_quat_rotate(self.map, qx, qy, qz, qw, cx, cy, cz)
def util_3d_lighting(self, Evas_Coord lx, Evas_Coord ly, Evas_Coord lz,
int lr, int lg, int lb, int ar, int ag, int ab):
- """util_3d_lighting(Evas_Coord lx, Evas_Coord ly, Evas_Coord lz, int
lr, int lg, int lb, int ar, int ag, int ab)
-
- Perform lighting calculations on the given Map
+ """Perform lighting calculations on the given Map
This is used to apply lighting calculations (from a single light
source)
to a given map. The R, G and B values of each vertex will be modified
to
@@ -246,9 +229,7 @@ cdef class Map(object):
evas_map_util_3d_lighting(self.map, lx, ly, lz, lr, lg, lb, ar, ag, ab)
def util_3d_perspective(self, Evas_Coord px, Evas_Coord py, Evas_Coord z0,
Evas_Coord foc):
- """util_3d_perspective(Evas_Coord px, Evas_Coord py, Evas_Coord z0,
Evas_Coord foc)
-
- Apply a perspective transform to the map
+ """Apply a perspective transform to the map
This applies a given perspective (3D) to the map coordinates. X, Y and
Z
values are used. The px and py points specify the "infinite distance"
point
@@ -349,9 +330,7 @@ cdef class Map(object):
return evas_map_count_get(self.map)
def point_coord_set(self, int idx, Evas_Coord x, Evas_Coord y, Evas_Coord
z):
- """point_coord_set(int idx, Evas_Coord x, Evas_Coord y, Evas_Coord z)
-
- Change the map point's coordinate.
+ """Change the map point's coordinate.
This sets the fixed point's coordinate in the map. Note that points
describe the outline of a quadrangle and are ordered either clockwise
@@ -377,9 +356,7 @@ cdef class Map(object):
evas_map_point_coord_set(self.map, idx, x, y, z)
def point_coord_get(self, int idx):
- """point_coord_get(int idx)
-
- Get the map point's coordinate.
+ """Get the map point's coordinate.
This returns the coordinates of the given point in the map.
@@ -402,9 +379,7 @@ cdef class Map(object):
# self.point_coord_set(*value)
def point_image_uv_set(self, int idx, double u, double v):
- """point_image_uv_set(int idx, double u, double v)
-
- Change the map point's U and V texture source point
+ """Change the map point's U and V texture source point
This sets the U and V coordinates for the point. This determines which
coordinate in the source image is mapped to the given point, much like
@@ -419,9 +394,7 @@ cdef class Map(object):
evas_map_point_image_uv_set(self.map, idx, u, v)
def point_image_uv_get(self, int idx):
- """point_image_uv_get(int idx)
-
- Get the map point's U and V texture source points
+ """Get the map point's U and V texture source points
This returns the texture points set by evas_map_point_image_uv_set().
@@ -444,9 +417,7 @@ cdef class Map(object):
# self.point_image_uv_set(*value)
def point_color_set(self, int idx, int r, int g, int b, int a):
- """point_color_set(int idx, int r, int g, int b, int a)
-
- Set the color of a vertex in the map
+ """Set the color of a vertex in the map
This sets the color of the vertex in the map. Colors will be linearly
interpolated between vertex points through the map. Color will multiply
@@ -464,9 +435,7 @@ cdef class Map(object):
evas_map_point_color_set(self.map, idx, r, g, b, a)
def point_color_get(self, int idx):
- """point_color_get(int idx)
-
- Get the color set on a vertex in the map
+ """Get the color set on a vertex in the map
This gets the color set by point_color_set() on the given vertex
of the map.
diff --git a/efl/evas/efl.evas_object.pxi b/efl/evas/efl.evas_object.pxi
index 9545cc0..e5cdd06 100644
--- a/efl/evas/efl.evas_object.pxi
+++ b/efl/evas/efl.evas_object.pxi
@@ -271,25 +271,15 @@ cdef class Object(Eo):
def raise_(self):
- """raise_()
-
- Raise to the top of its layer.
-
- """
+ """Raise to the top of its layer."""
evas_object_raise(self.obj)
def lower(self):
- """lower()
-
- Lower to the bottom of its layer.
-
- """
+ """Lower to the bottom of its layer. """
evas_object_lower(self.obj)
def stack_above(self, Object above):
- """stack_above(Object above)
-
- Reorder to be above the given one.
+ """Reorder to be above the given one.
:param above:
:type above: :py:class:`efl.evas.Object`
@@ -298,9 +288,7 @@ cdef class Object(Eo):
evas_object_stack_above(self.obj, above.obj)
def stack_below(self, Object below):
- """stack_below(Object below)
-
- Reorder to be below the given one.
+ """Reorder to be below the given one.
:param below:
:type below: :py:class:`efl.evas.Object`
@@ -405,9 +393,7 @@ cdef class Object(Eo):
evas_object_resize(self.obj, w, h)
def resize(self, int w, int h):
- """resize(int w, int h)
-
- Same as assigning to :py:attr:`size`.
+ """Same as assigning to :py:attr:`size`.
:param w: Width.
:type w: int
@@ -947,9 +933,7 @@ cdef class Object(Eo):
evas_object_size_hint_padding_set(self.obj, l, r, t, b)
def move(self, int x, int y):
- """move(int x, int y)
-
- Same as assigning to :py:attr:`pos`.
+ """Same as assigning to :py:attr:`pos`.
:param x:
:type x: int
@@ -960,9 +944,7 @@ cdef class Object(Eo):
evas_object_move(self.obj, x, y)
def move_relative(self, int dx, int dy):
- """move_relative(int dx, int dy)
-
- Move relatively to objects current position.
+ """Move relatively to objects current position.
:param dx:
:type dx: int
@@ -1187,7 +1169,6 @@ cdef class Object(Eo):
def clip_unset(self):
evas_object_clip_unset(self.obj)
-
property clipees:
"""Objects that this object clips.
@@ -1237,9 +1218,7 @@ cdef class Object(Eo):
evas_object_focus_set(self.obj, value)
def event_callback_add(self, Evas_Callback_Type type, func, *args,
**kargs):
- """event_callback_add(Evas_Callback_Type type, func, *args, **kargs)
-
- Add a new callback for the given event.
+ """Add a new callback for the given event.
:param type: an integer with event type code, like
*EVAS_CALLBACK_MOUSE_IN*, *EVAS_CALLBACK_KEY_DOWN* and
@@ -1274,9 +1253,7 @@ cdef class Object(Eo):
evas_object_event_callback_add(self.obj, type, cb, <void*>self)
def event_callback_del(self, Evas_Callback_Type type, func):
- """event_callback_del(Evas_Callback_Type type, func)
-
- Remove callback for the given event.
+ """Remove callback for the given event.
:param type: an integer with event type code.
:type type: int
diff --git a/efl/evas/efl.evas_object_grid.pxi
b/efl/evas/efl.evas_object_grid.pxi
index 5ae9cdb..f54c35b 100644
--- a/efl/evas/efl.evas_object_grid.pxi
+++ b/efl/evas/efl.evas_object_grid.pxi
@@ -73,9 +73,7 @@ cdef class Grid(Object):
return bool(evas_object_grid_mirrored_get(self.obj))
def pack(self, Object child not None, int x, int y, int w, int h):
- """pack(Object child, int x, int y, int w, int h)
-
- Add a new child to a grid object.
+ """Add a new child to a grid object.
:param child: The child object to add.
:param x: The virtual x coordinate of the child
@@ -89,9 +87,7 @@ cdef class Grid(Object):
raise RuntimeError("Could not pack child to grid.")
def unpack(self, Object child not None):
- """unpack(Object child)
-
- Remove child from grid.
+ """Remove child from grid.
:param child:
:raise RuntimeError: if removing the child fails.
@@ -107,9 +103,7 @@ cdef class Grid(Object):
raise RuntimeError("Could not remove child from grid.")
def clear(self, bint clear):
- """clear(bool clear)
-
- Faster way to remove all child objects from a grid object.
+ """Faster way to remove all child objects from a grid object.
:param clear: if True, it will delete just removed children.
@@ -117,9 +111,7 @@ cdef class Grid(Object):
evas_object_grid_clear(self.obj, clear)
def pack_get(self, Object child not None):
- """pack_get(Object child) -> tuple
-
- Get the pack options for a grid child
+ """Get the pack options for a grid child
Get the pack x, y, width and height in virtual coordinates set by
evas_object_grid_pack()
diff --git a/efl/evas/efl.evas_object_image.pxi
b/efl/evas/efl.evas_object_image.pxi
index 16154ff..0ab3e43 100644
--- a/efl/evas/efl.evas_object_image.pxi
+++ b/efl/evas/efl.evas_object_image.pxi
@@ -638,9 +638,7 @@ cdef class Image(Object):
# evas_object_image_data_copy_set(self.obj, void *data)
def image_data_update_add(self, x, y, w, h):
- """image_data_update_add(int x, int y, int w, int h)
-
- Mark a sub-region of the image to be redrawn.
+ """Mark a sub-region of the image to be redrawn.
This function schedules a particular rectangular region
to be updated (redrawn) at the next render.
@@ -694,9 +692,7 @@ cdef class Image(Object):
evas_object_image_smooth_scale_set(self.obj, value)
def preload(self, int cancel=0):
- """preload(bool cancel=False)
-
- Preload image data asynchronously.
+ """Preload image data asynchronously.
This will request Evas to create a thread to load image data
from file, decompress and convert to pre-multiplied format
@@ -726,9 +722,7 @@ cdef class Image(Object):
evas_object_image_reload(self.obj)
def save(self, filename, key=None, flags=None):
- """save(unicode filename, unicode key=None, unicode flags=None)
-
- Save image to file.
+ """Save image to file.
:param filename: where to save.
:type filename: unicode
@@ -989,7 +983,6 @@ cdef class Image(Object):
# Evas_Video_Surface *evas_object_image_video_surface_get(self.obj)
property scale_hint:
-
"""The scale hint value of the image object in the canvas,
which will affect how Evas is to cache scaled versions of its
original source image.
@@ -1257,9 +1250,7 @@ cdef class Image(Object):
return evas_object_image_animated_loop_count_get(self.obj)
def animated_frame_duration_get(self, int start_frame, int fram_num):
- """animated_frame_duration_get(int start_frame, int fram_num) -> double
-
- Get the duration of a sequence of frames.
+ """Get the duration of a sequence of frames.
:param start_frame: The first frame
:type start_frame: int
@@ -1340,10 +1331,7 @@ cdef void _cb_on_filled_image_resize(void *data, Evas *e,
cdef class FilledImage(Image):
-
- """
-
- Image that automatically resize it's contents to fit object size.
+ """Image that automatically resize it's contents to fit object size.
This :py:class:`Image` subclass already calls :py:attr:`Image.fill`
on resize so it will match and so be scaled to fill the whole area.
@@ -1381,9 +1369,7 @@ cdef class FilledImage(Image):
_object_mapping_register("Evas_FilledImage", FilledImage)
def extension_can_load(filename):
- """extension_can_load(unicode filename) -> bool
-
- Check if a file extension is supported by :py:class:`Image`.
+ """Check if a file extension is supported by :py:class:`Image`.
:param filename: The file to check
:type filename: unicode
diff --git a/efl/evas/efl.evas_object_line.pxi
b/efl/evas/efl.evas_object_line.pxi
index 06083a0..d3de5b2 100644
--- a/efl/evas/efl.evas_object_line.pxi
+++ b/efl/evas/efl.evas_object_line.pxi
@@ -17,9 +17,7 @@
cdef class Line(Object):
- """
-
- A straight line.
+ """A straight line.
:param canvas: Evas canvas for this object
:type canvas: efl.evas.Canvas
diff --git a/efl/evas/efl.evas_object_polygon.pxi
b/efl/evas/efl.evas_object_polygon.pxi
index 8ffc312..6c50ceb 100644
--- a/efl/evas/efl.evas_object_polygon.pxi
+++ b/efl/evas/efl.evas_object_polygon.pxi
@@ -17,9 +17,7 @@
cdef class Polygon(Object):
- """
-
- A polygon.
+ """A polygon.
:param canvas: Evas canvas for this object
:type canvas: Canvas
diff --git a/efl/evas/efl.evas_object_rectangle.pxi
b/efl/evas/efl.evas_object_rectangle.pxi
index 9213aed..800915f 100644
--- a/efl/evas/efl.evas_object_rectangle.pxi
+++ b/efl/evas/efl.evas_object_rectangle.pxi
@@ -17,9 +17,7 @@
cdef class Rectangle(Object):
- """
-
- A rectangle.
+ """A rectangle.
There is only one function to deal with rectangle objects, this may make
this function seem useless given there are no functions to manipulate
diff --git a/efl/evas/efl.evas_object_smart.pxi
b/efl/evas/efl.evas_object_smart.pxi
index 06f6006..08fdbfc 100644
--- a/efl/evas/efl.evas_object_smart.pxi
+++ b/efl/evas/efl.evas_object_smart.pxi
@@ -449,9 +449,7 @@ cdef class SmartObject(Object):
return self.members_get()
def callback_add(self, char *event, func, *args, **kargs):
- """callback_add(event, func, *args, **kargs)
-
- Add a callback for the smart event specified by event.
+ """Add a callback for the smart event specified by event.
:param event: Event name
:param func:
diff --git a/efl/evas/efl.evas_object_table.pxi
b/efl/evas/efl.evas_object_table.pxi
index 05154a9..56b99a3 100644
--- a/efl/evas/efl.evas_object_table.pxi
+++ b/efl/evas/efl.evas_object_table.pxi
@@ -174,9 +174,7 @@ cdef class Table(Object):
return bool(evas_object_table_mirrored_get(self.obj))
def pack_get(self, Object child):
- """pack_get(Object child)
-
- Get packing location of a child of table
+ """Get packing location of a child of table
:param child: The child object to add.
:param col: pointer to store relative-horizontal position to place
child.
@@ -194,9 +192,7 @@ cdef class Table(Object):
return (col, row, colspan, rowspan)
def pack(self, Object child, unsigned short col, unsigned short row,
unsigned short colspan, unsigned short rowspan):
- """pack(Object child, unsigned short col, unsigned short row, unsigned
short colspan, unsigned short rowspan)
-
- Add a new child to a table object or set its current packing.
+ """Add a new child to a table object or set its current packing.
:param child: The child object to add.
:param col: relative-horizontal position to place child.
@@ -211,9 +207,7 @@ cdef class Table(Object):
raise RuntimeError("Could not pack the child to the table.")
def unpack(self, Object child):
- """unpack(Object child)
-
- Remove child from table.
+ """Remove child from table.
.. note::
@@ -228,9 +222,7 @@ cdef class Table(Object):
raise RuntimeError("Could not remove child from the table.")
def clear(self, clear):
- """clear(clear)
-
- Faster way to remove all child objects from a table object.
+ """Faster way to remove all child objects from a table object.
:param clear: if True, it will delete just removed children.
@@ -259,9 +251,7 @@ cdef class Table(Object):
return (cols, rows)
def children_get(self):
- """children_get() -> list
-
- Get the list of children for the table.
+ """Get the list of children for the table.
:type: list of Objects
@@ -273,9 +263,7 @@ cdef class Table(Object):
return ret
def child_get(self, int col, int row):
- """child_get(int col, int row) -> Object
-
- Get the child of the table at the given coordinates
+ """Get the child of the table at the given coordinates
:param col:
:type col: int
diff --git a/efl/evas/efl.evas_object_text.pxi
b/efl/evas/efl.evas_object_text.pxi
index 5db324d..a671756 100644
--- a/efl/evas/efl.evas_object_text.pxi
+++ b/efl/evas/efl.evas_object_text.pxi
@@ -17,10 +17,7 @@
cdef class Text(Object):
-
- """
-
- Text.
+ """Text.
:param canvas: Evas canvas for this object
:type canvas: Canvas
@@ -207,9 +204,7 @@ cdef class Text(Object):
return evas_object_text_inset_get(self.obj)
def char_pos_get(self, int char_index):
- """char_pos_get(int char_index) -> (x, y, w, h)
-
- Retrieve position and dimension information of a character.
+ """Retrieve position and dimension information of a character.
This function is used to obtain the **x**, **y**, **width** and
**height**
of a the character located at **char_index** within this object.
@@ -226,9 +221,7 @@ cdef class Text(Object):
return (x, y, w, h)
def char_coords_get(self, int x, int y):
- """char_coords_get(int x, int y)
-
- Retrieve position and dimension information of a character at
+ """Retrieve position and dimension information of a character at
desired position.
Like :py:func:`char_pos_get`, but instead of providing the character
diff --git a/efl/evas/efl.evas_object_textblock.pxi
b/efl/evas/efl.evas_object_textblock.pxi
index f538b2d..28fbfec 100644
--- a/efl/evas/efl.evas_object_textblock.pxi
+++ b/efl/evas/efl.evas_object_textblock.pxi
@@ -17,7 +17,6 @@
cdef class Textblock(Object):
-
"""A Textblock.
:param canvas: Evas canvas for this object
@@ -106,9 +105,7 @@ cdef class Textblock(Object):
<const char *>value if value is not None else NULL)
def line_number_geometry_get(self, int index):
- """line_number_geometry_get(int index) -> (int x, int y, int w, int h)
-
- Retrieve position and dimension information of a specific line.
+ """Retrieve position and dimension information of a specific line.
This function is used to obtain the **x**, **y**, **width** and
**height**
of a the line located at **index** within this object.
@@ -124,11 +121,7 @@ cdef class Textblock(Object):
return (x, y, w, h)
def clear(self):
- """clear()
-
- Clear the Textblock
-
- """
+ """Clear the Textblock"""
evas_object_textblock_clear(self.obj)
property size_formatted:
diff --git a/efl/evas/efl.evas_object_textgrid.pxi
b/efl/evas/efl.evas_object_textgrid.pxi
index 6425875..e65e2a9 100644
--- a/efl/evas/efl.evas_object_textgrid.pxi
+++ b/efl/evas/efl.evas_object_textgrid.pxi
@@ -202,7 +202,6 @@ cdef class TextgridCell(object):
return <bint>self.cell.bg_extended
property double_width:
-
"""If the codepoint is merged with the following cell to the right
visually (cells must be in pairs with 2nd cell being a duplicate in
all ways except codepoint is 0)
@@ -327,9 +326,7 @@ cdef class Textgrid(Object):
return (w, h)
def palette_set(self, Evas_Textgrid_Palette pal, int idx, int r, int g,
int b, int a):
- """palette_set(Evas_Textgrid_Palette pal, int idx, int r, int g, int
b, int a)
-
- The set color to the given palette at the given index of the given
textgrid object.
+ """The set color to the given palette at the given index of the given
textgrid object.
:param pal: The type of the palette to set the color.
:param idx: The index of the paletter to wich the color is stored.
@@ -355,9 +352,7 @@ cdef class Textgrid(Object):
evas_object_textgrid_palette_set(self.obj, pal, idx, r, g, b, a)
def palette_get(self, Evas_Textgrid_Palette pal, int idx):
- """palette_get(Evas_Textgrid_Palette pal, int idx) -> (int r, int g,
int b, int a)
-
- The retrieve color to the given palette at the given index of the
given textgrid object.
+ """The retrieve color to the given palette at the given index of the
given textgrid object.
:param pal: The type of the palette to set the color.
:param idx: The index of the paletter to wich the color is stored.
@@ -389,9 +384,7 @@ cdef class Textgrid(Object):
return evas_object_textgrid_supported_font_styles_get(self.obj)
def cellrow_set(self, int y, list row not None):
- """cellrow_set(int y, list row)
-
- Set the string at the given row of the given textgrid object.
+ """Set the string at the given row of the given textgrid object.
:param y: The row index of the grid.
:type y: int
@@ -425,9 +418,7 @@ cdef class Textgrid(Object):
evas_object_textgrid_cellrow_set(self.obj, y, crow[0])
def cellrow_get(self, int y):
- """cellrow_get(int y) -> list
-
- Get the string at the given row of the given textgrid object.
+ """Get the string at the given row of the given textgrid object.
:param y: The row index of the grid.
:return: A pointer to the first cell of the given row.
@@ -460,9 +451,7 @@ cdef class Textgrid(Object):
return ret
def update_add(self, int x, int y, int w, int h):
- """update_add(int x, int y, int w, int h)
-
- Indicate for evas that part of a textgrid region (cells) has been
updated.
+ """Indicate for evas that part of a textgrid region (cells) has been
updated.
:param x: The rect region of cells top-left x (column)
:param y: The rect region of cells top-left y (row)
diff --git a/efl/evas/efl.evas_rect.pxi b/efl/evas/efl.evas_rect.pxi
index 364ed15..8317ee2 100644
--- a/efl/evas/efl.evas_rect.pxi
+++ b/efl/evas/efl.evas_rect.pxi
@@ -17,9 +17,7 @@
cdef class Rect(object):
- """
-
- Type to store and manipulate rectangular coordinates.
+ """Type to store and manipulate rectangular coordinates.
This class provides the description of a rectangle and means to
access and modify its properties in an easy way.
@@ -437,9 +435,7 @@ cdef class Rect(object):
self.y0 <= o.top and o.bottom <= self.y1)
def contains(self, obj):
- """contains(obj) -> bool
-
- Checks if contains given rectangle.
+ """Checks if contains given rectangle.
:param obj:
:rtype: bool
@@ -448,9 +444,7 @@ cdef class Rect(object):
return obj in self
def contains_point(self, x, y):
- """contains_point(x, y) -> bool
-
- Checks if contains the given point.
+ """Checks if contains the given point.
:param x:
:type x: int
@@ -463,9 +457,7 @@ cdef class Rect(object):
self.y0 <= y <= self.y1)
def intercepts(self, obj):
- """intercepts(obj) -> bool
-
- Checks if intercepts given rectangle.
+ """Checks if intercepts given rectangle.
:param obj:
:rtype: bool
@@ -499,9 +491,7 @@ cdef class Rect(object):
return bool((a or b) and (c or d))
def clip(self, obj):
- """clip(obj) -> Rect
-
- Returns a new Rect that represents current cropped inside parameter.
+ """Returns a new Rect that represents current cropped inside parameter.
:param obj:
:rtype: Rect
@@ -536,9 +526,7 @@ cdef class Rect(object):
return Rect(0, 0, 0, 0)
def union(self, obj):
- """union(obj) -> Rect
-
- Returns a new Rect that covers both rectangles.
+ """Returns a new Rect that covers both rectangles.
:param obj:
:rtype: Rect
@@ -568,9 +556,7 @@ cdef class Rect(object):
return Rect(left, top, right - left, bottom - top)
def clamp(self, obj):
- """clamp(obj) -> Rect
-
- Returns a new Rect that represents current moved inside given
+ """Returns a new Rect that represents current moved inside given
parameter.
If given rectangle is smaller, it'll be centered.
@@ -614,9 +600,7 @@ cdef class Rect(object):
return ret
def move_by(self, int offset_x, int offset_y):
- """move_by(int offset_x, int offset_y) -> Rect
-
- Returns a new Rect that represents current moved by given offsets.
+ """Returns a new Rect that represents current moved by given offsets.
:param offset_x:
:type offset_x: int
@@ -628,9 +612,7 @@ cdef class Rect(object):
return Rect(self.x0 + offset_x, self.y0 + offset_y, self._w, self._h)
def inflate(self, int amount_w, int amount_h):
- """inflate(int amount_w, int amount_h)
-
- Returns a new Rect that represents current inflated by given amount.
+ """Returns a new Rect that represents current inflated by given amount.
:param amount_x:
:type amount_x: int
--
