summaryrefslogtreecommitdiff
path: root/src/scripts/gendoc/doc_start.template
blob: 3a5ebfefbd8f0f3b9185b3bdf5f9d629ccfc7a14 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<!--(include)-->doc_macros.include<!--(end)-->#!
~~Title: EFL Reference~~
{{page>:develop:api-include:reference:general&nouser&nolink&nodate}}

====== Python-EFL documentation preview ======
This is just a work in progress for the future development of the
Python-EFL Unified API.

Practically there is nothing python related currently in this documentation,
so it can be considered valid for all languages.


<!--(for ns in nspaces)-->
===== ${ns.name}$ (namespace) =====

   <!--(for i, cls in enumerate(sorted(ns.regulars)))-->
      <!--(if i == 0)-->
^ Regular Classes ^^
      <!--(end)-->
| ${CLS_LINK}$ | ${BEST_SUMMARY(obj=cls)}$ |
   <!--(end)-->
#!
   <!--(for i, cls in enumerate(sorted(ns.abstracts)))-->
      <!--(if i == 0)-->
^ Abstract Classes ^^
      <!--(end)-->
| ${CLS_LINK}$ | ${BEST_SUMMARY(obj=cls)}$ |
   <!--(end)-->
#!
   <!--(for i, cls in enumerate(sorted(ns.mixins)))-->
      <!--(if i == 0)-->
^ Mixins ^^
      <!--(end)-->
| ${CLS_LINK}$ | ${BEST_SUMMARY(obj=cls)}$ |
   <!--(end)-->
#!
   <!--(for i, cls in enumerate(sorted(ns.interfaces)))-->
      <!--(if i == 0)-->
^ Interfaces ^^
      <!--(end)-->
| ${CLS_LINK}$ | ${BEST_SUMMARY(obj=cls)}$ |
   <!--(end)-->
#!
   <!--(for i, typedecl in enumerate(sorted(ns.aliases)))-->
      <!--(if i == 0)-->
^ Aliases ^^
      <!--(end)-->
| ${TYPEDECL_LINK}$ | ${BEST_SUMMARY(obj=typedecl)}$ |
   <!--(end)-->
#!
   <!--(for i, typedecl in enumerate(sorted(ns.structs)))-->
      <!--(if i == 0)-->
^ Structures ^^
      <!--(end)-->
| ${TYPEDECL_LINK}$ | ${BEST_SUMMARY(obj=typedecl)}$ |
   <!--(end)-->
#!
   <!--(for i, typedecl in enumerate(sorted(ns.enums)))-->
      <!--(if i == 0)-->
^ Enumerations ^^
      <!--(end)-->
| ${TYPEDECL_LINK}$ | ${BEST_SUMMARY(obj=typedecl)}$ |
   <!--(end)-->

<!--(end)-->