summaryrefslogtreecommitdiff
path: root/doc/misc_functions.rst
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff-webhosting.net>2023-01-29 16:18:01 +0100
committerJörg Frings-Fürst <debian@jff-webhosting.net>2023-01-29 16:18:01 +0100
commite829867cc2d6879a0aeb50c08ae40ebc56b4e6b1 (patch)
tree7465150c86969e66a90e4b960bb3537485205842 /doc/misc_functions.rst
parent6c88f3bab0b743487b367712fa1ec27d1f87389e (diff)
parentcd47bd564d7fc6177ba2e231d76bf352978409b8 (diff)
Merge branch 'feature/upstream' into develop
Diffstat (limited to 'doc/misc_functions.rst')
-rw-r--r--doc/misc_functions.rst16
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/misc_functions.rst b/doc/misc_functions.rst
index 0f1bdaf..43dacfe 100644
--- a/doc/misc_functions.rst
+++ b/doc/misc_functions.rst
@@ -8,7 +8,6 @@ Miscellaneous functions
int HX_ffs(unsigned long z);
int HX_fls(unsigned long z);
- void HX_hexdump(FILE *fp, const void *ptr, unsigned int len);
void HX_zvecfree(char **);
unsigned int HX_zveclen(const char *const *);
@@ -21,11 +20,6 @@ Miscellaneous functions
Finds the last (most-significant) bit in a value and returns its
position, or ``-1`` to indicate failure.
-``HX_hexdump``
- Outputs a nice pretty-printed hex and ASCII dump to the filedescriptor
- ``fp``. ``ptr`` is the memory area, of which ``len`` bytes will be
- dumped.
-
``HX_zvecfree``
Frees the supplied Z-vector array. (Frees all array elements from the
first element to (excluding) the first ``NULL`` element.)
@@ -33,3 +27,13 @@ Miscellaneous functions
``HX_zveclen``
Counts the number of array elements until the first ``NULL`` array
element is seen, and returns this number.
+
+.. code-block:: c
+
+ #include <libHX/io.h>
+ void HX_hexdump(FILE *fp, const void *ptr, unsigned int len);
+
+``HX_hexdump``
+ Outputs a nice pretty-printed hex and ASCII dump to the filedescriptor
+ ``fp``. ``ptr`` is the memory area, of which ``len`` bytes will be
+ dumped.