summaryrefslogtreecommitdiff
path: root/support/dktools/libdk4maiodh.dox
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/dktools/libdk4maiodh.dox
Initial commit
Diffstat (limited to 'support/dktools/libdk4maiodh.dox')
-rw-r--r--support/dktools/libdk4maiodh.dox36
1 files changed, 36 insertions, 0 deletions
diff --git a/support/dktools/libdk4maiodh.dox b/support/dktools/libdk4maiodh.dox
new file mode 100644
index 0000000000..d5ff542639
--- /dev/null
+++ b/support/dktools/libdk4maiodh.dox
@@ -0,0 +1,36 @@
+/** @page libdk4maiodh libdk4maiodh
+
+@section secinputdh Convert text to number
+
+Retrieve integer number from dkChar text in hexadecimal notation.
+
+Data type | Header | Function
+:-------: | :----: | :-------
+char | dk4maidhic.h | dk4ma_input_dk_hex_char()
+unsigned char | dk4maidhuc.h | dk4ma_input_dk_hex_uchar()
+short | dk4maidhis.h | dk4ma_input_dk_hex_short()
+unsigned short | dk4maidhus.h | dk4ma_input_dk_hex_ushort()
+int | dk4maidhii.h | dk4ma_input_dk_hex_int()
+unsigned | dk4maidhui.h | dk4ma_input_dk_hex_uint()
+long | dk4maidhil.h | dk4ma_input_dk_hex_long()
+unsigned long | dk4maidhul.h | dk4ma_input_dk_hex_ulong()
+long long | dk4maidhli.h | dk4ma_input_dk_hex_ll()
+unsigned long long | dk4maidhlu.h | dk4ma_input_dk_hex_ull()
+intmax_t | dk4maidhmi.h | dk4ma_input_dk_hex_intmax_t()
+uintmax_t | dk4maidhmu.h | dk4ma_input_dk_hex_uintmax_t()
+dk4_im_t | dk4maidhdi.h | dk4ma_input_dk_hex_dk4_im_t()
+dk4_um_t | dk4maidhdu.h | dk4ma_input_dk_hex_dk4_um_t()
+
+@section secioutputdh Convert number to text
+
+Convert integer number to dkChar text in hexadecimal notation.
+
+Data type | Header | Function
+:-------: | :----: | :-------
+dk4_im_t | dk4maodh.h | dk4ma_write_hex_unsigned()
+dk4_um_t | dk4maodh.h | dk4ma_write_hex_signed()
+
+You can cast all other signed integer values to dk4_im_t and all other
+unsigned integer values to dk4_um_t without loss.
+
+*/