[hipl-commit] [trunk] Rev 3672: Missing doxygen for firewall/pisa_cert.c

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

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

Log:
  Missing doxygen for firewall/pisa_cert.c

Modified:
  D  firewall/pisa_cert.c.doxyme
  M  firewall/pisa_cert.c

=== modified file 'firewall/pisa_cert.c'
--- firewall/pisa_cert.c        2010-02-10 23:02:52 +0000
+++ firewall/pisa_cert.c        2010-02-17 22:28:29 +0000
@@ -141,6 +141,13 @@
     return;
 }
 
+/**
+ * Splits a certificate into semantic chunks and converts these to
+ * sensible binary representations.
+ *
+ * @param cert    the original certificate
+ * @param pc[out] internal representation of the certificate
+ */
 void pisa_split_cert(char *cert, struct pisa_cert *pc)
 {
     struct tm t;

=== removed file 'firewall/pisa_cert.c.doxyme'
--- firewall/pisa_cert.c.doxyme 2010-02-11 17:34:50 +0000
+++ firewall/pisa_cert.c.doxyme 1970-01-01 00:00:00 +0000
@@ -1,54 +0,0 @@
-/**
- * @file firewall/pisa_cert.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.
-
-
-
-
-/**
- * pisa_split_cert
- *
- *
- * @param cert
- * @param pc
- * @return
- */

Other related posts:

  • » [hipl-commit] [trunk] Rev 3672: Missing doxygen for firewall/pisa_cert.c - Tobias Heer