summaryrefslogtreecommitdiff
path: root/src/scripts/gendoc/doc_struct.template
blob: 370e9be6e9318b3568453ba6bf8f3f8bf0b924f4 (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
<!--(include)-->doc_macros.include<!--(end)-->#!
~~Title: ${struct.full_name}$~~
====== ${struct.full_name}$ (struct) ======

${BEST_SUMMARY(obj=struct)}$

${BEST_DESCRIPTION(obj=struct)}$

${BEST_SINCE(obj=struct)}$

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

===== Fields =====

${OBJECT_STATIC_CONTENT(obj=struct, section='fields')}$

<!--(for field in struct.struct_fields)-->
  * **${field.name}$** - ${BEST_SUMMARY(obj=field)}$
<!--(end)-->

===== Signature =====

<code>
struct ${struct.full_name}$ {
<!--(for field in struct.struct_fields)-->
    ${field.name}$: ${field.type.name}$,
<!--(end)-->
}
</code>

===== C Signature =====

<code>
typedef struct _${struct.full_name.replace('.', '_')}$ {
<!--(for field in struct.struct_fields)-->
    ${field.name}$: **TODO (issue with Typedecl.c_type need Unit)**,
<!--(end)-->
} ${struct.full_name.replace('.', '_')}$;
</code>