From 0c85158f6e149728ad8d7c164c5839856bd655f9 Mon Sep 17 00:00:00 2001 From: Reiner Herrmann Date: Sat, 29 Jan 2011 17:21:16 +0100 Subject: added further net/ documentation (including payload formats) --- src/net/client.c | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'src/net/client.c') diff --git a/src/net/client.c b/src/net/client.c index 72d7322..eec83a5 100644 --- a/src/net/client.c +++ b/src/net/client.c @@ -195,7 +195,9 @@ bool client_parse_hello(const msg_t *m) } /** - * Prepare hello message with client's nickname + * Prepare hello message with client's nickname\n + * Payload format:\n + * [ nickname:strlen(nickname) ] * @param[out] m Pointer to message that should be filled */ void client_prep_hello(msg_t *m) @@ -208,7 +210,9 @@ void client_prep_hello(msg_t *m) } /** - * Prepare message with selected card + * Prepare message with selected card\n + * Payload format:\n + * [ selected_card:1 ] * @param[out] m Pointer to message that should be filled */ void client_prep_selected_card(msg_t *m) @@ -223,7 +227,9 @@ void client_prep_selected_card(msg_t *m) } /** - * Prepare message with selected stack + * Prepare message with selected stack\n + * Payload format:\n + * [ stack_index:1 ] * @param[out] m Pointer to message that should be filled */ void client_prep_selected_stack(msg_t *m) -- cgit v1.2.3