[hipl-commit] [trunk] Rev 3972: Doxygen header for bos.c

  • From: Miika Komu <miika@xxxxxx>
  • To: hipl-commit@xxxxxxxxxxxxx
  • Date: Tue, 16 Mar 2010 23:57:00 +0200

Committer: Miika Komu <miika@xxxxxx>
Date: 16/03/2010 at 23:57:00
Revision: 3972
Revision-id: miika@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: trunk

Log:
  Doxygen header for bos.c

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

=== modified file 'hipd/bos.c'
--- hipd/bos.c  2010-03-08 22:21:34 +0000
+++ hipd/bos.c  2010-03-16 21:56:59 +0000
@@ -1,3 +1,17 @@
+/**
+ * @file
+ *
+ * Distributed under <a href="http://www.gnu.org/licenses/gpl2.txt";>GNU/GPL</a>
+ *
+ * BOS packet was defined in
+ * <a 
href="http://tools.ietf.org/html/draft-ietf-hip-base-00";>draft-ietf-hip-base-00
+ * </a> but it was removed in later revisions. It can be used to broadcast your
+ * own identity (and IP address) to the local network. Privacy proponents 
beware!
+ *
+ * @brief BOS packet sending and receiving functionality
+ *
+ * @author Anthony D. Joseph
+ *
 /* required for s6_addr32 */
 #define _BSD_SOURCE
 
@@ -35,7 +49,8 @@
     return err;
 }
 
-/** hip_socket_send_bos - send a BOS packet
+/**
+ * hip_socket_send_bos - send a BOS packet
  * @param msg input message (should be empty)
  *
  * Generate a signed HIP BOS packet containing our HIT, and send

Other related posts:

  • » [hipl-commit] [trunk] Rev 3972: Doxygen header for bos.c - Miika Komu