[hipl-commit] [trunk] Rev 4007: Updated doxygen in hipd/user.c

  • From: Miika Komu <miika@xxxxxx>
  • To: hipl-commit@xxxxxxxxxxxxx
  • Date: Thu, 18 Mar 2010 15:21:43 +0200

Committer: Miika Komu <miika@xxxxxx>
Date: 18/03/2010 at 15:21:43
Revision: 4007
Revision-id: miika@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: trunk

Log:
  Updated doxygen in hipd/user.c

Modified:
  M  hipd/user.c

=== modified file 'hipd/user.c'
--- hipd/user.c 2010-03-18 13:19:05 +0000
+++ hipd/user.c 2010-03-18 13:21:41 +0000
@@ -20,6 +20,7 @@
  * @author  Bing Zhou <bingzhou_cc.hut.fi>
  * @author  Tao Wan  <twan_cc.hut.fi>
  * @author  Rene Hummen
+ * @todo split the gigantic hip_handle_user_msg() into an array of handler 
functions
  */
 
 /* required for s6_addr32 */
@@ -34,6 +35,13 @@
 #include "lib/core/hip_udp.h"
 #include "hipd.h"
 
+/**
+ * send a response message back to the origin
+ *
+ * @param msg the message to send
+ * @param dst the destination of the message
+ * @return zero on success, or negative error value on error.
+ */
 int hip_sendto_user(const struct hip_common *msg, const struct sockaddr *dst)
 {
     HIP_DEBUG("Sending msg type %d\n", hip_get_msg_type(msg));
@@ -48,9 +56,8 @@
  *       add a case block for your HIP_MSG_NEWMODE constant in the
  *       switch(msg_type) block in this function.
  * @param  msg  a pointer to the received user message HIP packet.
- * @param  src
+ * @param  src the origin of the sender
  * @return zero on success, or negative error value on error.
- * @see    hip_so.
  */
 int hip_handle_user_msg(hip_common_t *msg, struct sockaddr_in6 *src)
 {

Other related posts:

  • » [hipl-commit] [trunk] Rev 4007: Updated doxygen in hipd/user.c - Miika Komu