summaryrefslogtreecommitdiff
path: root/lib/util/util.c
diff options
context:
space:
mode:
authorMichael Adam <obnox@samba.org>2011-10-18 18:07:54 +0200
committerMichael Adam <obnox@samba.org>2011-10-18 20:58:26 +0200
commitcb47890cf2734afff502cf8b95635ebc75bc5974 (patch)
treee110887d0cbcbe3b0db9997c749feed8301d5a07 /lib/util/util.c
parent5d91a2680e594d47ed137b45f79738bddb641cea (diff)
downloadsamba-cb47890cf2734afff502cf8b95635ebc75bc5974.tar.gz
samba-cb47890cf2734afff502cf8b95635ebc75bc5974.tar.bz2
samba-cb47890cf2734afff502cf8b95635ebc75bc5974.zip
lib/util: fix function header comment to strhex_to_str()
The description did not match the function's behaviour.
Diffstat (limited to 'lib/util/util.c')
-rw-r--r--lib/util/util.c17
1 files changed, 8 insertions, 9 deletions
diff --git a/lib/util/util.c b/lib/util/util.c
index c5ed6fd0c7..67ac6938a4 100644
--- a/lib/util/util.c
+++ b/lib/util/util.c
@@ -689,15 +689,14 @@ _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
}
/**
- Routine to get hex characters and turn them into a 16 byte array.
- the array can be variable length, and any non-hex-numeric
- characters are skipped. "0xnn" or "0Xnn" is specially catered
- for.
-
- valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
-
-
-**/
+ * Routine to get hex characters and turn them into a byte array.
+ * the array can be variable length.
+ * - "0xnn" or "0Xnn" is specially catered for.
+ * - The first non-hex-digit character (apart from possibly leading "0x"
+ * finishes the conversion and skips the rest of the input.
+ *
+ * valid examples: "0A5D15"; "0x123456"
+ */
_PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len)
{
size_t i = 0;