[hipl-commit] [trunk] Rev 3676: Added default doxygen header for midauth and pisa files in firewall/

  • From: Tobias Heer <heer@xxxxxxxxxxxxxxxxx>
  • To: hipl-commit@xxxxxxxxxxxxx
  • Date: Thu, 18 Feb 2010 11:06:51 +0200

Committer: Tobias Heer <heer@xxxxxxxxxxxxxxxxx>
Date: Thu Feb 18 10:06:49 2010 +0100
Revision: 3676
Revision-id: heer@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: trunk

Log:
  Added default doxygen header for midauth and pisa files in firewall/

Modified:
  M  firewall/midauth.c
  M  firewall/midauth.h
  M  firewall/pisa.c
  M  firewall/pisa.h
  M  firewall/pisa_cert.c
  M  firewall/pisa_cert.h

=== modified file 'firewall/midauth.c'
--- firewall/midauth.c  2010-02-17 22:41:06 +0000
+++ firewall/midauth.c  2010-02-18 09:06:49 +0000
@@ -1,14 +1,18 @@
-/** @file
+/**
+ * @file firewall/midauth.c
+ *
+ * Distributed under <a href="http://www.gnu.org/licenses/gpl2.txt";>GNU/GPL</a>
+ *
  * This file provides a framework for modifying HIP packets. It includes
  * adding new parameters in the correct order and adapting the various
  * headers.
  *
+ * @brief Framework for the midauth extensions
+ *
  * @author Thomas Jansen
  * @author Dominic Gatzen
  *
- * This code is GNU/GPL.
- *
- * According to draft-heer-hip-middle-auth-00 we SHOULD support IP-level
+ * @note: According to draft-heer-hip-middle-auth-00 we SHOULD support IP-level
  * fragmentation for IPv6 and MUST support IP-level fragmentation for IPv4.
  * Currently we do neither.
  */
@@ -216,7 +220,7 @@
 
 /**
  * Verify that the challenge response in a packet is valid
- * 
+ *
  * @param hip packet that contains the challenge response
  * @param s   challenge response parameter
  * @return    0 on success, <0 otherwise

=== modified file 'firewall/midauth.h'
--- firewall/midauth.h  2010-02-17 13:08:39 +0000
+++ firewall/midauth.h  2010-02-18 09:06:49 +0000
@@ -1,8 +1,14 @@
-/** @file
- * A header file for midauth.c.
- *
+/**
+ * @file firewall/midauth.h
+ *
+ * Distributed under <a href="http://www.gnu.org/licenses/gpl2.txt";>GNU/GPL</a>
+ *
+ * @brief The header file for firewall/midauth.c
+ * *
  * @author Thomas Jansen
+ *
  */
+
 #ifndef HIP_FIREWALL_MIDAUTH_H
 #define HIP_FIREWALL_MIDAUTH_H
 

=== modified file 'firewall/pisa.c'
--- firewall/pisa.c     2010-02-17 22:19:45 +0000
+++ firewall/pisa.c     2010-02-18 09:06:49 +0000
@@ -1,12 +1,16 @@
-/** @file
+/**
+ * @file firewall/pisa.c
+ *
+ * Distributed under <a href="http://www.gnu.org/licenses/gpl2.txt";>GNU/GPL</a>
+ *
  * This file contains PISA specific functions for the firewall. The basic idea
  * is to modify the HIP messages and manage state for allowed connections to
  * allow or reject associated ESP traffic.
  *
+ * @brief PISA functions for the firewall
+ * *
  * @author Thomas Jansen
  * @author Dominic Gatzen
- *
- * This code is GNU/GPL.
  */
 
 /* required by the libipq header for IFNAMSZ */

=== modified file 'firewall/pisa.h'
--- firewall/pisa.h     2010-02-17 13:08:39 +0000
+++ firewall/pisa.h     2010-02-18 09:06:49 +0000
@@ -1,8 +1,13 @@
-/** @file
- * A header file for pisa.c.
+/**
+ * @file firewall/pisa.h
+ *
+ * Distributed under <a href="http://www.gnu.org/licenses/gpl2.txt";>GNU/GPL</a>
+ *
+ * @brief A header file for pisa.c
  *
  * @author Thomas Jansen
  */
+
 #ifndef HIP_FIREWALL_PISA_H
 #define HIP_FIREWALL_PISA_H
 

=== modified file 'firewall/pisa_cert.c'
--- firewall/pisa_cert.c        2010-02-17 22:28:29 +0000
+++ firewall/pisa_cert.c        2010-02-18 09:06:49 +0000
@@ -1,9 +1,16 @@
-/** @file
+/**
+ * @file firewall/pisa_cert.c
+ *
+ * Distributed under <a href="http://www.gnu.org/licenses/gpl2.txt";>GNU/GPL</a>
+ *
  * This file deals with the PISA specific handling of SPKI certificates. The
  * certificate is parsed and split into small chunks.
  *
+ * @brief PISA handling for SPKI certificates
+ * *
  * @author Thomas Jansen
  */
+
 #include "pisa_cert.h"
 
 #include <sys/types.h>

=== modified file 'firewall/pisa_cert.h'
--- firewall/pisa_cert.h        2010-02-17 13:08:39 +0000
+++ firewall/pisa_cert.h        2010-02-18 09:06:49 +0000
@@ -1,8 +1,13 @@
-/** @file
- * A header file for pisa_cert.c.
- *
+/**
+ * @file firewall/pisa_cert.h
+ *
+ * Distributed under <a href="http://www.gnu.org/licenses/gpl2.txt";>GNU/GPL</a>
+ *
+ * @brief The header file for firewall/pisa_cert.c
+ * *
  * @author Thomas Jansen
  */
+
 #ifndef HIP_FIREWALL_PISA_CERT_H
 #define HIP_FIREWALL_PISA_CERT_H

Other related posts:

  • » [hipl-commit] [trunk] Rev 3676: Added default doxygen header for midauth and pisa files in firewall/ - Tobias Heer