[hipl-commit] [trunk] Rev 4014: Doxygen for hipd/update_legacy.c

  • From: Miika Komu <miika@xxxxxx>
  • To: hipl-commit@xxxxxxxxxxxxx
  • Date: Thu, 18 Mar 2010 19:23:38 +0200

Committer: Miika Komu <miika@xxxxxx>
Date: 18/03/2010 at 19:23:38
Revision: 4014
Revision-id: miika@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: trunk

Log:
  Doxygen for hipd/update_legacy.c

Modified:
  D  hipd/update_legacy.c.doxyme
  M  hipd/update_legacy.c

=== modified file 'hipd/update_legacy.c'
--- hipd/update_legacy.c        2010-02-17 17:38:08 +0000
+++ hipd/update_legacy.c        2010-03-18 17:23:37 +0000
@@ -1,7 +1,12 @@
 /**
+ * @file
+ * Distributed under <a 
href="http://www.gnu.org/licenses/gpl2.txt";>GNU/GPL</a>.
+ *
  * This file contains legacy functions for mobility that should be rewritten 
for modularity.
  * They are still included in the code base due to locator dependencies with 
DHT and
- * base exchange code.
+ * base exchange code. See bugzilla ids 926 and 927.
+ *
+ * @author Baris Boyvat
  */
 
 /* required for s6_addr32 */
@@ -9,6 +14,13 @@
 
 #include "update_legacy.h"
 
+/**
+ * build a LOCATOR parameter for an UPDATE packet
+ *
+ * @param msg the LOCATOR parameter will be appended to this UPDATE message
+ * @param spi the SPI number for this UPDATE
+ * @return zero on success on negative on failure
+ */
 int hip_build_locators_old(struct hip_common *msg, uint32_t spi)
 {
     int err                                 = 0, i = 0, count = 0;
@@ -17,16 +29,12 @@
     hip_list_t *item                        = NULL, *tmp = NULL;
     struct hip_locator_info_addr_item *locs = NULL;
 
-    //TODO count the number of UDP relay servers.
-    // check the control state of every hatb_state.
-
     if (address_count == 0) {
         HIP_DEBUG("Host has only one or no addresses no point "
                   "in building LOCATOR2 parameters\n");
         goto out_err;
     }
 
-    //TODO check out the count for UDP and hip raw.
     addr_max = address_count;
 
     HIP_IFEL(!(locs = malloc(addr_max *

Other related posts:

  • » [hipl-commit] [trunk] Rev 4014: Doxygen for hipd/update_legacy.c - Miika Komu