[hipl-commit] [tiny] Rev 3758: Doxygen for hip_check_i1.

  • From: Tim Just <tim.just@xxxxxxxxxxxxxx>
  • To: hipl-commit@xxxxxxxxxxxxx
  • Date: Wed, 31 Mar 2010 19:04:58 +0300

Committer: Tim Just <tim.just@xxxxxxxxxxxxxx>
Date: 31/03/2010 at 19:04:58
Revision: 3758
Revision-id: tim.just@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: tiny

Log:
  Doxygen for hip_check_i1.

Modified:
  M  hipd/input.c

=== modified file 'hipd/input.c'
--- hipd/input.c        2010-03-31 16:03:43 +0000
+++ hipd/input.c        2010-03-31 16:04:43 +0000
@@ -1250,6 +1250,20 @@
     return err;
 }
 
+/**
+ * hip_check_i1
+ *
+ * Check a received I1 control packet.
+ *
+ * @param packet_type The packet type of the control message (RFC 5201, 5.3.)
+ * @param ha_state The host association state (RFC 5201, 4.4.1.)
+ * @param *ctx Pointer to the packet context, containing all information for
+ *             the packet handling (received message, source and destination
+ *             address, the ports and the corresponding entry from the host
+               association database).
+ *
+ * @return zero on success, or negative error value on error.
+ */
 int hip_check_i1(const uint8_t packet_type,
                  const uint32_t ha_state,
                  struct hip_packet_context *ctx)

Other related posts:

  • » [hipl-commit] [tiny] Rev 3758: Doxygen for hip_check_i1. - Tim Just