aboutsummaryrefslogtreecommitdiff
path: root/client/parse.h
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-06-22 17:00:51 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-06-22 17:00:51 +0200
commit3667d9a9955face0d4a147319cc902cbf8c95299 (patch)
treef69e49dabd6b5fc1618d2a21ab77e8fee0463d4e /client/parse.h
parent33d17dbab86c1277a1327273fb9753b2c98b7b03 (diff)
more client docs
Diffstat (limited to 'client/parse.h')
-rw-r--r--client/parse.h14
1 files changed, 14 insertions, 0 deletions
diff --git a/client/parse.h b/client/parse.h
index 94afe70..8b7d235 100644
--- a/client/parse.h
+++ b/client/parse.h
@@ -2,11 +2,23 @@
#include <stddef.h>
+/**
+ * \ingroup pbc
+ * \defgroup pbc_parse parse
+ * \brief Debug send command parser utilities
+ * \{
+ */
+
+//! Internal field separator (i.e. whitespace delimiter)
#define IFS " \t\n"
+//! Octal digit character set
#define SET_OCT "01234567"
+//! Decimal digit character set
#define SET_DEC "0123456789"
+//! Hexadecimal digit character set
#define SET_HEX SET_DEC"abcdefABCDEF"
+//! (Hexadecimal) byte string character set
#define SET_HEX_STR SET_HEX":"
/**
@@ -40,3 +52,5 @@ char* consume_token(char * token, const char * ifs);
*/
int strtodata(const char * str, char ** data, size_t * size);
+/// \}
+