@@ -86,33 +86,35 @@ The numeric structure of these is that they are all four-bit values of which the
8686
8787## Functions
8888
89- ** < span id = " group__QkBitTerm_1gad8255603d800498cc15ac43da08b11a3 " />uint8 \_ t qk\_ bitterm\_ label(QkBitTerm bit \_ term) **
89+ ### qk\_ bitterm\_ label
9090
91- Get the label for a bit term.
91+ <Function id = " qk_bitterm_label" signature = " uint8_t qk_bitterm_label(QkBitTerm bit_term)" >
92+ Get the label for a bit term.
9293
93- <span id = " group__QkBitTerm_1autotoc_md93" />
94+ <span id = " group__QkBitTerm_1autotoc_md93" />
9495
95- ### Example
96+ # ### Example
9697
97- ``` c
98- QkBitTerm bit_term = QkBitTerm_Y;
99- // cast the uint8_t to char
100- char label = qk_bitterm_label(bit_term);
101- ```
98+ ``` c
99+ QkBitTerm bit_term = QkBitTerm_Y;
100+ // cast the uint8_t to char
101+ char label = qk_bitterm_label(bit_term);
102+ ```
102103
103- <span id = " group__QkBitTerm_1autotoc_md94" />
104+ <span id = " group__QkBitTerm_1autotoc_md94" />
104105
105- ### Safety
106+ # ### Safety
106107
107- <span id = " group__QkBitTerm_1autotoc_md94" />
108+ <span id = " group__QkBitTerm_1autotoc_md94" />
108109
109- The behavior is undefined if ` bit_term ` is not a valid ` uint8_t ` value of a ` QkBitTerm ` .
110+ The behavior is undefined if ` bit_term ` is not a valid ` uint8_t ` value of a ` QkBitTerm ` .
110111
111- ** Parameters**
112+ ** Parameters**
112113
113- * ** bit\_ term** – The bit term.
114+ * ** bit\_ term** – The bit term.
114115
115- ** Returns**
116+ ** Returns**
116117
117- The label as ` uint8_t ` , which can be cast to ` char ` to obtain the character.
118+ The label as ` uint8_t ` , which can be cast to ` char ` to obtain the character.
119+ </Function >
118120
0 commit comments