From d865b2b56d107229ea4477667a425fb16da6b0f2 Mon Sep 17 00:00:00 2001 From: Gav Wood Date: Sat, 25 Jan 2014 01:36:34 -0500 Subject: [PATCH] Documentation. --- libethereum/Utility.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/libethereum/Utility.h b/libethereum/Utility.h index 93c3d54c8..893604139 100644 --- a/libethereum/Utility.h +++ b/libethereum/Utility.h @@ -29,6 +29,17 @@ namespace dev namespace eth { +/** + * Takes a user-authorable string with several whitespace delimited arguments and builds a byte array + * from it. Arguments can be hex data/numerals, decimal numbers or ASCII strings. Literals are padded + * to 32 bytes if prefixed by a '@' (or not prefixed at all), and tightly packed if prefixed by a '$'. + * Currency multipliers can be provided. + * + * Example: + * @code + * parseData("$42 0x42 $\"Hello\""); // == bytes(1, 0x2a) + bytes(31, 0) + bytes(1, 0x42) + asBytes("Hello"); + * @endcode + */ bytes parseData(std::string const& _args); }