summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKai Huuhko <kai.huuhko@gmail.com>2014-06-01 16:35:38 +0300
committerKai Huuhko <kai.huuhko@gmail.com>2014-06-01 16:35:38 +0300
commit4f702bc04d21aba5243a76acd21135bfba50e8f0 (patch)
treecbd7ece19937fb31193eff150eb60ae021ee6592
parent4639836d3e970a2a28de859e1bd000452d9404bc (diff)
Documentation: warnings--
-rw-r--r--doc/ecore/ecore.rst8
-rw-r--r--doc/evas/class-object.rst27
-rw-r--r--doc/evas/evas.rst4
-rw-r--r--efl/elementary/calendar_elm.pyx6
-rw-r--r--efl/elementary/configuration.pyx6
-rw-r--r--efl/elementary/object.pyx4
6 files changed, 40 insertions, 15 deletions
diff --git a/doc/ecore/ecore.rst b/doc/ecore/ecore.rst
index f675f33..6ac5ceb 100644
--- a/doc/ecore/ecore.rst
+++ b/doc/ecore/ecore.rst
@@ -101,11 +101,3 @@ API Reference
101 filedownload 101 filedownload
102 filemonitor 102 filemonitor
103 103
104
105Inheritance diagram
106-------------------
107
108.. inheritance-diagram::
109 efl.ecore
110 :parts: 2
111
diff --git a/doc/evas/class-object.rst b/doc/evas/class-object.rst
index 38e1558..06f5213 100644
--- a/doc/evas/class-object.rst
+++ b/doc/evas/class-object.rst
@@ -3,5 +3,32 @@
3:class:`efl.evas.Object` Class 3:class:`efl.evas.Object` Class
4============================== 4==============================
5 5
6.. _Evas_Keys:
7
8Key Input Functions
9===================
10
11Functions which feed key events to the canvas.
12
13As explained in :ref:`evas_main_intro_not_evas`, Evas is **not** aware of input
14systems at all. Then, the user, if using it crudely (evas_new()),
15will have to feed it with input events, so that it can react
16somehow. If, however, the user creates a canvas by means of the
17Ecore_Evas wrapper, it will automatically bind the chosen display
18engine's input events to the canvas, for you.
19
20This group presents the functions dealing with the feeding of key
21events to the canvas. On most of them, one has to reference a given
22key by a name (``keyname`` argument). Those are
23**platform dependent** symbolic names for the keys. Sometimes
24you'll get the right ``keyname`` by simply using an ASCII
25value of the key name, but it won't be like that always.
26
27Typical platforms are Linux frame buffer (Ecore_FB) and X server
28(Ecore_X) when using Evas with Ecore and Ecore_Evas. Please refer
29to your display engine's documentation when using evas through an
30Ecore helper wrapper when you need the ``keyname``'s.
31
32
6.. autoclass:: efl.evas.Object 33.. autoclass:: efl.evas.Object
7 :inherited-members: 34 :inherited-members:
diff --git a/doc/evas/evas.rst b/doc/evas/evas.rst
index 10bfeaf..fbcac8b 100644
--- a/doc/evas/evas.rst
+++ b/doc/evas/evas.rst
@@ -3,6 +3,8 @@
3 3
4.. module:: efl.evas 4.. module:: efl.evas
5 5
6.. _evas_main_intro:
7
6What is Evas? 8What is Evas?
7------------- 9-------------
8 10
@@ -27,6 +29,7 @@ wish, thus keeping it small and lean. It has several display
27back-ends, letting it display on several display systems, making it 29back-ends, letting it display on several display systems, making it
28portable for cross-device and cross-platform development. 30portable for cross-device and cross-platform development.
29 31
32.. _evas_main_intro_not_evas:
30 33
31What Evas is not? 34What Evas is not?
32----------------- 35-----------------
@@ -41,6 +44,7 @@ should be polled from various sources and fed to Evas. Similarly, it will
41not create windows or report windows updates to your system, rather just 44not create windows or report windows updates to your system, rather just
42drawing the pixels and reporting to the user the areas that were changed. 45drawing the pixels and reporting to the user the areas that were changed.
43 46
47.. _evas_main_work:
44 48
45How does Evas work? 49How does Evas work?
46------------------- 50-------------------
diff --git a/efl/elementary/calendar_elm.pyx b/efl/elementary/calendar_elm.pyx
index 963cc90..2997538 100644
--- a/efl/elementary/calendar_elm.pyx
+++ b/efl/elementary/calendar_elm.pyx
@@ -203,7 +203,9 @@ ELM_DAY_LAST = enums.ELM_DAY_LAST
203 203
204cdef class CalendarMark(object): 204cdef class CalendarMark(object):
205 205
206 """An item for the Calendar widget. 206 """
207
208 An item for the Calendar widget.
207 209
208 A mark that will be drawn in the calendar respecting the insertion 210 A mark that will be drawn in the calendar respecting the insertion
209 time and periodicity. It will emit the type as signal to the widget theme. 211 time and periodicity. It will emit the type as signal to the widget theme.
@@ -235,7 +237,7 @@ cdef class CalendarMark(object):
235 237
236 def __init__(self, evasObject cal, mark_type, mark_time, 238 def __init__(self, evasObject cal, mark_type, mark_time,
237 Elm_Calendar_Mark_Repeat_Type repeat): 239 Elm_Calendar_Mark_Repeat_Type repeat):
238 """ 240 """Create a new Calendar mark
239 241
240 :param mark_type: A string used to define the type of mark. It will be 242 :param mark_type: A string used to define the type of mark. It will be
241 emitted to the theme, that should display a related modification on these 243 emitted to the theme, that should display a related modification on these
diff --git a/efl/elementary/configuration.pyx b/efl/elementary/configuration.pyx
index e3c3b7d..ebfb7b7 100644
--- a/efl/elementary/configuration.pyx
+++ b/efl/elementary/configuration.pyx
@@ -661,7 +661,7 @@ cdef class Configuration(object):
661 property text_classes_list: 661 property text_classes_list:
662 """Get Elementary's list of supported text classes. 662 """Get Elementary's list of supported text classes.
663 663
664 :type: list of :ref:`Elm_Text_Class` 664 :type: list of tuples (name, desc)
665 665
666 """ 666 """
667 def __get__(self): 667 def __get__(self):
@@ -691,7 +691,7 @@ cdef class Configuration(object):
691 the default font properties for that class coming from the theme in 691 the default font properties for that class coming from the theme in
692 use. There is no need to free this list. 692 use. There is no need to free this list.
693 693
694 :type: list of :ref:`Elm_Font_Overlay` 694 :type: list of tuples (text_class, font, size)
695 695
696 """ 696 """
697 def __get__(self): 697 def __get__(self):
@@ -732,7 +732,7 @@ cdef class Configuration(object):
732 :param font: Font name and style string 732 :param font: Font name and style string
733 :type font: string 733 :type font: string
734 :param size: Font size 734 :param size: Font size
735 :type size: :ref:`Evas_Font_Size` 735 :type size: int
736 736
737 """ 737 """
738 a1 = text_class 738 a1 = text_class
diff --git a/efl/elementary/object.pyx b/efl/elementary/object.pyx
index 360e2a1..de1c695 100644
--- a/efl/elementary/object.pyx
+++ b/efl/elementary/object.pyx
@@ -102,7 +102,7 @@ Focus direction
102 102
103 .. versionadded:: 1.8.1 103 .. versionadded:: 1.8.1
104 104
105.. _Elm_Focus_Move_Policy 105.. _Elm_Focus_Move_Policy:
106 106
107Focus move policy 107Focus move policy
108================= 108=================
@@ -119,7 +119,7 @@ Focus move policy
119 119
120 .. versionadded:: 1.10 120 .. versionadded:: 1.10
121 121
122.. _Elm_Focus_Autoscroll_Mode 122.. _Elm_Focus_Autoscroll_Mode:
123 123
124Focus autoscroll mode 124Focus autoscroll mode
125===================== 125=====================