enlightenment/python-efl
enlightenment
/
python-efl
7
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Eolian: Change documentation to reflect the change to enum types

This commit is contained in:
Kai Huuhko 2014-06-11 01:16:20 +03:00
parent a4fa686a27
commit 0baba91e0a
1 changed files with 10 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
efl/eolian/__init__.pyx
View File

@ -1,52 +1,3 @@
"""
Enumerations
============
.. _Eolian_Function_Type:
Function Type
-------------
.. data:: EOLIAN_UNRESOLVED
.. data:: EOLIAN_PROPERTY
.. data:: EOLIAN_PROP_SET
.. data:: EOLIAN_PROP_GET
.. data:: EOLIAN_METHOD
.. data:: EOLIAN_CTOR
.. _Eolian_Parameter_Dir:
Parameter Direction
-------------------
.. data:: EOLIAN_IN_PARAM
.. data:: EOLIAN_OUT_PARAM
.. data:: EOLIAN_INOUT_PARAM
.. _Eolian_Class_Type:
Class Type
----------
.. data:: EOLIAN_CLASS_UNKNOWN_TYPE
.. data:: EOLIAN_CLASS_REGULAR
.. data:: EOLIAN_CLASS_ABSTRACT
.. data:: EOLIAN_CLASS_MIXIN
.. data:: EOLIAN_CLASS_INTERFACE
.. _Eolian_Function_Scope:
Function Scope
--------------
.. data:: EOLIAN_SCOPE_PUBLIC
.. data:: EOLIAN_SCOPE_PROTECTED
"""
from libc.stdint cimport uintptr_t
from cpython cimport PyUnicode_AsUTF8String
@ -55,6 +6,7 @@ from efl.utils.conversions cimport _ctouni, eina_list_strings_to_python_list
from efl.utils.enum import IntEnum
class FunctionType(IntEnum):
"""Function Type"""
UNRESOLVED = EOLIAN_UNRESOLVED
PROPERTY = EOLIAN_PROPERTY
PROP_SET = EOLIAN_PROP_SET
@ -63,11 +15,13 @@ class FunctionType(IntEnum):
CTOR = EOLIAN_CTOR
class ParameterDir(IntEnum):
"""Parameter Direction"""
IN_PARAM = EOLIAN_IN_PARAM
OUT_PARAM = EOLIAN_OUT_PARAM
INOUT_PARAM = EOLIAN_INOUT_PARAM
class ClassType(IntEnum):
"""Class Type"""
UNKNOWN = EOLIAN_CLASS_UNKNOWN_TYPE
REGULAR = EOLIAN_CLASS_REGULAR
ABSTRACT = EOLIAN_CLASS_ABSTRACT
@ -75,6 +29,7 @@ class ClassType(IntEnum):
INTERFACE = EOLIAN_CLASS_INTERFACE
class FunctionScope(IntEnum):
"""Function Scope"""
PUBLIC = EOLIAN_SCOPE_PUBLIC
PROTECTED = EOLIAN_SCOPE_PROTECTED
@ -287,7 +242,7 @@ cdef class Class(object):
property type:
"""Returns the class type of the given class
:type: :ref:`Eolian_Class_Type`
:type: :class:`ClassType`
"""
def __get__(self):
@ -444,7 +399,7 @@ cdef class Function(object):
property type:
"""Returns the type of a function
:type: :ref:`Eolian_Function_Type`
:type: :class:`FunctionType`
"""
def __get__(self):
@ -453,7 +408,7 @@ cdef class Function(object):
property scope:
"""Returns the scope of a function
:type: :ref:`Eolian_Function_Scope`
:type: :class:`FunctionScope`
"""
def __get__(self):
@ -645,7 +600,7 @@ cdef class FunctionParameter(object):
property information:
"""Get information about a function parameter
:type: :ref:`Eolian_Parameter_Dir` direction, string type, string name,
:type: :class:`ParameterDir` direction, string type, string name,
string description
"""
@ -799,8 +754,8 @@ cdef class Implement(object):
property information:
"""Get information about an overriding function (implement).
:type: overridden :py:class:`Class`, overridden :py:func:`Function`,
overridden :ref:`Eolian_Function_Type`
:type: overridden :py:class:`Class`, overridden :py:class:`Function`,
overridden :class:`FunctionType`
"""
def __get__(self):