summaryrefslogtreecommitdiff
path: root/src/net/client.c
diff options
context:
space:
mode:
authorReiner Herrmann <reiner@reiner-h.de>2011-01-29 17:21:16 +0100
committerReiner Herrmann <reiner@reiner-h.de>2011-01-29 17:21:16 +0100
commit0c85158f6e149728ad8d7c164c5839856bd655f9 (patch)
treedae857b558bb3478513c380003fdf64adc23946a /src/net/client.c
parent8c1d86bf31ab830e53e27def156f9bdb895c3471 (diff)
added further net/ documentation (including payload formats)
Diffstat (limited to 'src/net/client.c')
-rw-r--r--src/net/client.c12
1 files changed, 9 insertions, 3 deletions
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)