summaryrefslogtreecommitdiff
path: root/src/scripts/gendoc/doc_macros.include
blob: 483c3d4e91b5d0b06b827c2917cc1a4b35818935 (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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
#!##############################################################################
#!####  BEST_SUMMARY(obj)  #####################################################
#!##############################################################################
<!--(macro BEST_SUMMARY)-->
   <!--(if isinstance(obj, Documentation))-->
${UNTOKENIZE(tokens=obj.summary_tokens)}$#!
   <!--(elif isinstance(obj, Implement))-->
      <!--(if obj.documentation_get(obj.function.type))-->
${UNTOKENIZE(tokens=obj.documentation_get(obj.function.type).summary_tokens)}$#!
      <!--(else)-->
         <!--(for parent_impl in obj.class_.implements)-->
            <!--(if parent_impl.function.name == obj.function.name)-->
               <!--(if parent_impl.documentation_get(parent_impl.function.type))-->
${UNTOKENIZE(tokens=parent_impl.documentation_get(parent_impl.function.type).summary_tokens)}$#!
               <!--(end)-->
            <!--(end)-->
         <!--(end)-->
      <!--(end)-->
   <!--(elif obj and obj.documentation)-->
${UNTOKENIZE(tokens=obj.documentation.summary_tokens)}$#!
   <!--(else)-->
**MISSING DOCS !!!!!**#!
   <!--(end)-->
<!--(end)-->
#!##############################################################################
#!####  BEST_DESCRIPTION(obj)  #################################################
#!##############################################################################
<!--(macro BEST_DESCRIPTION)-->
   <!--(if isinstance(obj, Documentation))-->
${UNTOKENIZE(tokens=obj.description_tokens)}$#!
   <!--(elif isinstance(obj, Implement))-->
      <!--(if obj.documentation_get(obj.function.type))-->
${UNTOKENIZE(tokens=obj.documentation_get(obj.function.type).description_tokens)}$#!
      <!--(else)-->
         <!--(for parent_impl in obj.class_.implements)-->
            <!--(if parent_impl.function.name == obj.function.name)-->
               <!--(if parent_impl.documentation_get(parent_impl.function.type))-->
${UNTOKENIZE(tokens=parent_impl.documentation_get(parent_impl.function.type).description_tokens)}$#!
               <!--(end)-->
            <!--(end)-->
         <!--(end)-->
      <!--(end)-->
   <!--(elif obj and obj.documentation)-->
${UNTOKENIZE(tokens=obj.documentation.description_tokens)}$#!
   <!--(else)-->
**MISSING DOCS !!!!!**#!
   <!--(end)-->
<!--(end)-->
#!##############################################################################
#!####  BEST_SINCE(obj)  #######################################################
#!##############################################################################
<!--(macro BEST_SINCE)-->
   <!--(if isinstance(obj, Documentation) and obj.since)-->
//Since ${obj.since}$//
   <!--(elif isinstance(obj, Implement))-->
      <!--(if obj.documentation_get(obj.function.type))-->
//Since ${obj.documentation_get(obj.function.type).since}$//
      <!--(else)-->
         <!--(for parent_impl in obj.class_.implements)-->
            <!--(if parent_impl.function.name == obj.function.name)-->
               <!--(if parent_impl.documentation_get(parent_impl.function.type))-->
//Since ${parent_impl.documentation_get(parent_impl.function.type).since}$//
               <!--(end)-->
            <!--(end)-->
         <!--(end)-->
      <!--(end)-->
   <!--(elif obj and obj.documentation and obj.documentation.since)-->
//Since ${obj.documentation.since}$//
   <!--(end)-->
<!--(end)-->
#!##############################################################################
#!####  UNTOKENIZE(tokens)  ####################################################
#!##############################################################################
<!--(macro UNTOKENIZE)-->
   <!--(for i, paragraph in enumerate(tokens))-->
${'\n\n' if i else ''}$#!
      <!--(for token in paragraph)-->
         <!--(if token.type == Eolian_Doc_Token_Type.TEXT)-->
%%${token.text}$%%#!
         <!--(elif token.type == Eolian_Doc_Token_Type.REF)-->
**REF ${token.text}$ ${token.ref}$ ??**#!
         <!--(elif token.type == Eolian_Doc_Token_Type.MARKUP_MONOSPACE)-->
''${token.text}$''#!
         <!--(elif token.type == Eolian_Doc_Token_Type.MARK_NOTE)-->
<note>
${token.text}$
</note>
         <!--(elif token.type == Eolian_Doc_Token_Type.MARK_WARNING)-->
<note warning>
${token.text}$
</note>
         <!--(elif token.type == Eolian_Doc_Token_Type.MARK_REMARK)-->
<note tip>
${token.text}$
</note>
         <!--(elif token.type == Eolian_Doc_Token_Type.MARK_TODO)-->
<note>
**TODO:** ${token.text}$
</note>
         <!--(else)-->
**USUPPORTED TOKEN TYPE ${token}$**
         <!--(end)-->
      <!--(end)-->
   <!--(end)-->
<!--(end)-->
#!##############################################################################
#!####  CLS_TYPE(cls)  #########################################################
#!##############################################################################
<!--(macro CLS_TYPE)-->
   <!--(if cls.type == Eolian_Class_Type.REGULAR)-->
class#!
   <!--(elif cls.type == Eolian_Class_Type.ABSTRACT)-->
class#!
   <!--(elif cls.type == Eolian_Class_Type.MIXIN)-->
mixin#!
   <!--(elif cls.type == Eolian_Class_Type.INTERFACE)-->
interface#!
   <!--(end)-->
<!--(end)-->
#!##############################################################################
#!####  CLS_LINK(cls)  #########################################################
#!##############################################################################
<!--(macro CLS_LINK)-->
[[:develop:api#!
   <!--(for n in cls.namespaces)-->
:${n.lower()}$#!
   <!--(end)-->
:${cls.short_name.lower()}$|${cls.name}$]]
<!--(end)-->
#!##############################################################################
#!####  EVENT_LINK(cls, ev)  ###################################################
#!##############################################################################
<!--(macro EVENT_LINK)-->
[[:develop:api#!
   <!--(for n in cls.namespaces)-->
:${n.lower()}$#!
   <!--(end)-->
:${cls.short_name.lower()}$#!
:event#!
:${ev.short_name.lower().replace(',','_')}$|${ev.name}$]]
<!--(end)-->
#!##############################################################################
#!####  TYPEDECL_LINK(typedecl)  ###############################################
#!##############################################################################
<!--(macro TYPEDECL_LINK)-->
[[:develop:api#!
   <!--(for n in typedecl.namespaces)-->
:${n.lower()}$#!
   <!--(end)-->
:${typedecl.short_name.lower()}$|${typedecl.name}$]]
<!--(end)-->
#!##############################################################################
#!####  TYPE_LINK(type)  #######################################################
#!##############################################################################
<!--(macro TYPE_LINK)-->
[[:develop:api#!
   <!--(for n in type.namespaces)-->
:${n.lower()}$#!
   <!--(end)-->
:${type.short_name.lower()}$|${type.name}$]]
<!--(end)-->
#!##############################################################################
#!####  FUNC_LINK(func)  #######################################################
#!##############################################################################
<!--(macro FUNC_LINK)-->
[[:develop:api#!
   <!--(for n in func.class_.namespaces)-->
:${n.lower()}$#!
   <!--(end)-->
   <!--(if func.type == Eolian_Function_Type.METHOD)-->
:method#!
   <!--(else)-->
:property#!
   <!--(end)-->
:${func.short_name}$|${func.short_name}$]]
<!--(end)-->
#!##############################################################################
#!####  FUNC_SCOPE(func)  ######################################################
#!##############################################################################
<!--(macro FUNC_SCOPE)-->
   <!--(if func.is_class)-->
 ''class method'' #!
   <!--(end)-->
   <!--(if func.type == Eolian_Function_Type.PROPERTY)-->
      <!--(if func.getter_scope == Eolian_Object_Scope.PROTECTED)-->
 ''protected get'' #!
      <!--(elif func.getter_scope == Eolian_Object_Scope.PRIVATE)-->
 ''private get'' #!
      <!--(end)-->
      <!--(if func.setter_scope == Eolian_Object_Scope.PROTECTED)-->
 ''protected set'' #!
      <!--(elif func.setter_scope == Eolian_Object_Scope.PRIVATE)-->
 ''private set'' #!
      <!--(end)-->
   <!--(elif func.type == Eolian_Function_Type.METHOD)-->
      <!--(if func.method_scope == Eolian_Object_Scope.PROTECTED)-->
 ''protected'' #!
      <!--(elif func.method_scope == Eolian_Object_Scope.PRIVATE)-->
 ''private'' #!
      <!--(end)-->
   <!--(end)-->
<!--(end)-->
#!##############################################################################
#!####  OBJECT_SCOPE(obj)  #####################################################
#!##############################################################################
<!--(macro OBJECT_SCOPE)-->
   <!--(if obj.scope == Eolian_Object_Scope.PROTECTED)-->
 ''private'' #!
   <!--(elif obj.scope == Eolian_Object_Scope.PRIVATE)-->
 ''protected'' #!
   <!--(end)-->
<!--(end)-->
#!##############################################################################
#!####  EVENT_TAGS(ev)  ########################################################
#!##############################################################################
<!--(macro EVENT_TAGS)-->
   <!--(if ev.is_hot)-->
 ''hot'' #!
   <!--(elif ev.is_restart)-->
 ''restart'' #!
   <!--(end)-->
<!--(end)-->
#!##############################################################################
#!####  IMPLEMENT_TAGS(impl)  ##################################################
#!##############################################################################
<!--(macro IMPLEMENT_TAGS)-->
   <!--(if impl.is_prop_get and impl.is_prop_set)-->
 ''rw'' #!
   <!--(elif impl.is_prop_get)-->
 ''read only'' #!
   <!--(elif impl.is_prop_set)-->
 ''write only'' #!
   <!--(end)-->
<!--(end)-->
#!##############################################################################
#!####  PARAM_DIRECTION_TAG(param)  ############################################
#!##############################################################################
<!--(macro PARAM_DIRECTION_TAG)-->
      <!--(if param.direction == Eolian_Parameter_Dir.IN)-->
 ''in'' #!
      <!--(elif param.direction == Eolian_Parameter_Dir.OUT)-->
 ''out'' #!
      <!--(elif param.direction == Eolian_Parameter_Dir.INOUT)-->
 ''inout'' #!
      <!--(end)-->
<!--(end)-->
#!##############################################################################
#!####  METHOD_PARAMS(func)  ###################################################
#!##############################################################################
<!--(macro METHOD_PARAMS)-->

   <!--(for i, par in enumerate(func.parameters))-->
      <!--(if i == 0)-->
^ parameters ^ type ^ description ^
      <!--(end)-->
|${PARAM_DIRECTION_TAG(param=par)}$ **${par.name}$**|${par.type.name}$ #!
|${BEST_SUMMARY(obj=par)}$ ${BEST_DESCRIPTION(obj=par)}$|
   <!--(else)-->
**This function does not accept any parameter.**
   <!--(end)-->

   <!--(if func.method_return_type)-->
${setvar("obj", "func.return_documentation(Eolian_Function_Type.METHOD)")}$#!
^ return ^ description ^
|**${func.method_return_type.name}$**|${BEST_SUMMARY(obj=obj)}$ ${BEST_DESCRIPTION(obj=obj)}$|
   <!--(else)-->
**This function does not return anything.**
   <!--(end)-->

<!--(end)-->
#!##############################################################################
#!####  PROPERTY_PARAMS(func)  #################################################
#!##############################################################################
<!--(macro PROPERTY_PARAMS)-->

   <!--(for i, val in enumerate(func.getter_values or func.setter_values))-->
      <!--(if i == 0)-->
^ values ^ type ^ description ^
      <!--(end)-->
|**${val.name}$**|${val.type.name}$|${BEST_SUMMARY(obj=val)}$|
   <!--(end)-->

   <!--(for i, key in enumerate(func.getter_keys or func.setter_keys))-->
      <!--(if i == 0)-->
^ keys ^ type ^ description ^
      <!--(end)-->
|**${key.name}$**|${key.type.name}$|${BEST_SUMMARY(obj=key)}$|
   <!--(end)-->

<!--(end)-->
#!##############################################################################
#!####  IMPLEMENT_FULL(impl, cls)  #############################################
#!##############################################################################
<!--(macro IMPLEMENT_FULL)-->
**${FUNC_LINK(func=impl.function)}$** #!
(#!
   <!--(if impl.is_property)-->
      <!--(for i, val in enumerate(impl.function.getter_values or impl.function.setter_values))-->
${', ' if i else ''}$${val.type.short_name}$#!
      <!--(end)-->
   <!--(elif impl.is_method)-->
      <!--(for i, param in enumerate(impl.function.parameters))-->
${', ' if i else ''}$#!
//${param.type.short_name}$// ''${param.direction.name.lower()}$'' **${param.short_name}$**#!
      <!--(end)-->
   <!--(end)-->
) #!
${IMPLEMENT_TAGS}$ #!
   <!--(if impl.is_method)-->
      <!--(if impl.function.method_return_type)-->
 => //${impl.function.method_return_type.short_name}$// #!
      <!--(else)-->
 => //None// #!
      <!--(end)-->
   <!--(end)-->
${FUNC_SCOPE(func=impl.function)}$#!
   <!--(if impl.class_ != cls)-->
//[Overridden from ${CLS_LINK(cls=impl.class_)}$]// #!
   <!--(end)-->
\\

> ${BEST_SUMMARY(obj=impl)}$ ${BEST_SINCE(obj=impl)}$

++++ more... |

${BEST_DESCRIPTION(obj=impl)}$

   <!--(if impl.is_method)-->
${METHOD_PARAMS(func=impl.function)}$
   <!--(else)-->
${PROPERTY_PARAMS(func=impl.function)}$
   <!--(end)-->
++++

<!--(end)-->
#!##############################################################################
#!####  OBJECT_STATIC_CONTENT(obj, section)  ###################################
#!##############################################################################
<!--(macro OBJECT_STATIC_CONTENT)-->
{{page>:develop:api-include#!
   <!--(for ns in obj.namespaces)-->
:${ns.lower()}$#!
   <!--(end)-->
:${obj.name.lower()}$#!
:{section}#!
&nouser&nolink&nodate}}
<!--(end)-->