[hipl-commit] [trunk] Rev 3670: Doxygen for hipd/pisa.c

  • From: Tobias Heer <heer@xxxxxxxxxxxxxxxxx>
  • To: hipl-commit@xxxxxxxxxxxxx
  • Date: Thu, 18 Feb 2010 00:19:47 +0200

Committer: Tobias Heer <heer@xxxxxxxxxxxxxxxxx>
Date: Wed Feb 17 23:19:45 2010 +0100
Revision: 3670
Revision-id: heer@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: trunk

Log:
  Doxygen for hipd/pisa.c

Modified:
  D  hipd/pisa.c.doxyme
  M  firewall/pisa.c
  M  hipd/pisa.c

=== modified file 'firewall/pisa.c'
--- firewall/pisa.c     2010-02-12 17:00:10 +0000
+++ firewall/pisa.c     2010-02-17 22:19:45 +0000
@@ -552,7 +552,11 @@
     pisa_remove_connection(ctx);
     return NF_ACCEPT;
 }
-
+/**
+ * Initialize basic PISA functionality
+ *
+ * @param h function pointers for packet handlers
+ */
 void pisa_init(struct midauth_handlers *h)
 {
     char hit[INET6_ADDRSTRLEN];

=== modified file 'hipd/pisa.c'
--- hipd/pisa.c 2010-02-10 22:32:46 +0000
+++ hipd/pisa.c 2010-02-17 22:19:45 +0000
@@ -38,6 +38,15 @@
     return 0;
 }
 
+/**
+ * Load a certificate from disk and return a pointer to the global 
+ * variable containing it.
+ *
+ * @see hip_pisa_load_certificate*
+ *
+ * @param void
+ * @return pointer to midauth_cert
+ */
 char *hip_pisa_get_certificate(void)
 {
     hip_pisa_load_certificate();

=== removed file 'hipd/pisa.c.doxyme'
--- hipd/pisa.c.doxyme  2010-02-11 17:34:50 +0000
+++ hipd/pisa.c.doxyme  1970-01-01 00:00:00 +0000
@@ -1,62 +0,0 @@
-/**
- * @file hipd/pisa.c
- *
- * <LICENSE TEMLPATE LINE - LEAVE THIS LINE INTACT>
- *
- * Write description of source file here for dOxygen. Be as precise as 
possible.
- * Please also note how and by which parts of the code this file should be 
used.
- *
- * @brief Write a short summary
- *
- * @author <Put all existing author information here>
- * @author another Author another@xxxxxxxxxx
- */
-
-
-
-///  Single line comment for dOxygen.
-
-/**
- * my_great_function
- *
- * Write description of function here.
- * The function should follow these comments.
- *
- * Document the use of each function variable and indicate if this
- * argument is used to return information to the calling context. Use
- * [out] for outut parameters (This is very important). Align the
- * descriptions to improve readability.
- *
- *  @note: put important usage informations to notes.
- *
- *  @param      firstArg     Description of first function argument.
- *  @param[out] secondArg    Description of second function argument.
- *  @param      thirdArg     Description of third function argument.
- *  @return Description of returned value.
- */
-
-int my_great_function(int firstArg, char **secondArg, int thirdArg)
-{
-    .....
-
-/// Now it's your turn.
-
-
-
-
-/**
- * hip_pisa_get_certificate
- *
- *
- * @param void
- * @return
- */
-
-
-/**
- * hip_pisa_load_certificate
- *
- *
- * @param void
- * @return
- */

Other related posts:

  • » [hipl-commit] [trunk] Rev 3670: Doxygen for hipd/pisa.c - Tobias Heer