summaryrefslogtreecommitdiff
path: root/src/scripts/gendoc/doc_class.template
blob: 6daaa5f08718d4af24882611753af09b09b11489 (plain) (blame)
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
<!--(include)-->doc_macros.include<!--(end)-->#!
~~Title: ${cls.name}$~~
====== ${cls.name}$ (${CLS_TYPE}$) ======

${BEST_SUMMARY(obj=cls)}$

${BEST_DESCRIPTION(obj=cls)}$

${BEST_SINCE(obj=cls)}$

${OBJECT_STATIC_CONTENT(obj=cls, section='description')}$

<!--(if len(list(cls.inherits)) > 0)-->
===== Inheritance =====

  <!--(for inherit in cls.hierarchy)-->
 => ${CLS_LINK(cls=inherit)}$#!
  <!--(end)-->

++++ Full hierarchy |

  <!--(for inherit in cls.inherits)-->
  * ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)//
    <!--(for inherit in inherit.inherits)-->
    * ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)//
      <!--(for inherit in inherit.inherits)-->
      * ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)//
        <!--(for inherit in inherit.inherits)-->
        * ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)//
          <!--(for inherit in inherit.inherits)-->
          * ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)//
            <!--(for inherit in inherit.inherits)-->
            * ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)//
              <!--(for inherit in inherit.inherits)-->
              * ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)//
                <!--(for inherit in inherit.inherits)-->
                * ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)//
                  <!--(for inherit in inherit.inherits)-->
                  * ${CLS_LINK(cls=inherit)}$ //(${CLS_TYPE(cls=inherit)}$)//
                    <!--(for inherit in inherit.inherits)-->
                    * ${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)-->
${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)-->
${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 inherits defined in this class.
<!--(end)-->

===== Events =====

<!--(for i, ev in enumerate(cls.events))-->
  <!--(if i == 0)-->
^ Local implemented ^^ 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)-->
<!--(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)-->
<!--(end)-->