2018-01-03 07:18:58 -08:00
|
|
|
<!--(include)-->doc_macros.include<!--(end)-->#!
|
2018-03-17 03:37:13 -07:00
|
|
|
~~Title: ${enum.name}$~~
|
|
|
|
====== ${enum.name}$ (enum) ======
|
2018-01-03 07:18:58 -08:00
|
|
|
|
2019-10-05 01:30:34 -07:00
|
|
|
<!--(if enum.is_beta)-->
|
|
|
|
''beta'' This enumeration is still in beta, api will probably change
|
|
|
|
<!--(end)-->
|
|
|
|
|
2018-01-03 07:18:58 -08:00
|
|
|
${BEST_SUMMARY(obj=enum)}$
|
|
|
|
|
|
|
|
${BEST_DESCRIPTION(obj=enum)}$
|
|
|
|
|
|
|
|
${BEST_SINCE(obj=enum)}$
|
|
|
|
|
|
|
|
${OBJECT_STATIC_CONTENT(obj=enum, section='description')}$
|
|
|
|
|
|
|
|
===== Fields =====
|
|
|
|
|
|
|
|
${OBJECT_STATIC_CONTENT(obj=enum, section='fields')}$
|
|
|
|
|
|
|
|
<!--(for field in enum.enum_fields)-->
|
|
|
|
* **${field.name}$** - ${BEST_SUMMARY(obj=field)}$
|
|
|
|
<!--(end)-->
|
|
|
|
|
|
|
|
===== Signature =====
|
|
|
|
|
|
|
|
<code>
|
|
|
|
enum {
|
|
|
|
<!--(for field in enum.enum_fields)-->
|
2018-03-17 03:37:13 -07:00
|
|
|
${field.name}$: ${field.value.serialize}$
|
2018-01-03 07:18:58 -08:00
|
|
|
<!--(end)-->
|
|
|
|
}
|
|
|
|
</code>
|
|
|
|
|
|
|
|
===== C Signature =====
|
|
|
|
|
|
|
|
<code>
|
|
|
|
typedef enum {
|
|
|
|
<!--(for field in enum.enum_fields)-->
|
2019-10-03 11:18:54 -07:00
|
|
|
${field.c_constant}$ = ${field.value.serialize}$,
|
2018-01-03 07:18:58 -08:00
|
|
|
<!--(end)-->
|
2018-03-17 03:37:13 -07:00
|
|
|
} ${enum.name.replace('.', '_')}$;
|
2018-01-03 07:18:58 -08:00
|
|
|
</code>
|