forked from enlightenment/efl
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
112 lines
3.6 KiB
112 lines
3.6 KiB
<!--(include)-->doc_macros.include<!--(end)-->#! |
|
~~Title: ${cls.name}$~~ |
|
====== ${cls.name}$ (${CLS_TYPE}$) ====== |
|
|
|
<!--(if cls.is_beta)--> |
|
''beta'' This class is still in beta, api will probably change |
|
<!--(end)--> |
|
|
|
${BEST_SUMMARY(obj=cls)}$ |
|
|
|
${BEST_DESCRIPTION(obj=cls)}$ |
|
|
|
${BEST_SINCE(obj=cls)}$ |
|
|
|
${OBJECT_STATIC_CONTENT(obj=cls, section='description')}$ |
|
|
|
<!--(if len(list(cls.extensions)) > 0)--> |
|
===== Inheritance ===== |
|
|
|
<!--(for inherit in cls.hierarchy)--> |
|
=> ${CLS_LINK(cls=inherit)}$#! |
|
<!--(end)--> |
|
|
|
++++ Full hierarchy | |
|
|
|
<!--(for inherit in cls.extensions)--> |
|
* ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)// |
|
<!--(for inherit in inherit.extensions)--> |
|
* ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)// |
|
<!--(for inherit in inherit.extensions)--> |
|
* ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)// |
|
<!--(for inherit in inherit.extensions)--> |
|
* ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)// |
|
<!--(for inherit in inherit.extensions)--> |
|
* ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)// |
|
<!--(for inherit in inherit.extensions)--> |
|
* ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)// |
|
<!--(for inherit in inherit.extensions)--> |
|
* ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)// |
|
<!--(for inherit in inherit.extensions)--> |
|
* ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)// |
|
<!--(for inherit in inherit.extensions)--> |
|
* ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)// |
|
<!--(for inherit in inherit.extensions)--> |
|
* ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)// |
|
<!--(end)--> |
|
<!--(end)--> |
|
<!--(end)--> |
|
<!--(end)--> |
|
<!--(end)--> |
|
<!--(end)--> |
|
<!--(end)--> |
|
<!--(end)--> |
|
<!--(end)--> |
|
<!--(end)--> |
|
|
|
++++ |
|
<!--(end)--> |
|
|
|
===== Properties ===== |
|
|
|
<!--(for impl in cls.implements)--> |
|
<!--(if impl.is_property)--> |
|
{{anchor:${impl.short_name}$}} |
|
${IMPLEMENT_FULL(impl=impl, cls=cls)}$ |
|
<!--(end)--> |
|
<!--(else)--> |
|
No properties defined in this class. |
|
<!--(end)--> |
|
|
|
===== Methods ===== |
|
|
|
<!--(for impl in cls.implements)--> |
|
<!--(if impl.is_method)--> |
|
{{anchor:${impl.short_name}$}} |
|
${IMPLEMENT_FULL(impl=impl, cls=cls)}$ |
|
<!--(end)--> |
|
<!--(else)--> |
|
No methods defined in this class. |
|
<!--(end)--> |
|
|
|
===== Inherited members ===== |
|
|
|
<!--(for cls2 in cls.inherits_full)--> |
|
^ ${CLS_LINK(cls=cls2)}$ //(${CLS_TYPE(cls=cls2)}$)//^^^ |
|
<!--(for impl in cls2.implements)--> |
|
| ${FUNC_SCOPE(func=impl.function)}$ #! |
|
| **${FUNC_LINK(func=impl.function)}$** #! |
|
| ${BEST_SUMMARY(obj=impl)}$ | |
|
<!--(end)--> |
|
<!--(else)--> |
|
No extensions defined in this class. |
|
<!--(end)--> |
|
|
|
===== Events ===== |
|
|
|
<!--(for i, ev in enumerate(cls.events))--> |
|
<!--(if i == 0)--> |
|
^ Local implemented ^^ event info ^ |
|
<!--(end)--> |
|
| {{anchor:event_${ev.short_name.lower().replace(',','_')}$}}''${ev.name}$'' | ${BEST_SUMMARY(obj=ev)}$ ${OBJECT_SCOPE(obj=ev)}$ ${EVENT_TAGS}$| ${TYPE_LINK(type=ev.type) if ev.type else 'None'}$ | |
|
<!--(end)--> |
|
<!--(for cls2 in cls.inherits_full)--> |
|
<!--(for i, ev in enumerate(cls2.events))--> |
|
<!--(if i == 0)--> |
|
^ Inherited from ${CLS_LINK(cls=cls2)}$ //(${CLS_TYPE(cls=cls2)}$)// ^^ event info ^ |
|
<!--(end)--> |
|
| ''${ev.name}$'' | ${BEST_SUMMARY(obj=ev)}$ ${OBJECT_SCOPE(obj=ev)}$ ${EVENT_TAGS}$ | ${TYPE_LINK(type=ev.type) if ev.type else 'None'}$ | |
|
<!--(end)--> |
|
<!--(else)--> |
|
No events defined in this class. |
|
<!--(end)-->
|
|
|