[hipl-commit] [trunk] Rev 3671: Removed doxyme. Everything in there was documented already. However, I am not done with the firewall/pisa.c file yet
- From: Tobias Heer <heer@xxxxxxxxxxxxxxxxx>
- To: hipl-commit@xxxxxxxxxxxxx
- Date: Thu, 18 Feb 2010 00:22:07 +0200
Committer: Tobias Heer <heer@xxxxxxxxxxxxxxxxx>
Date: Wed Feb 17 23:22:06 2010 +0100
Revision: 3671
Revision-id: heer@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: trunk
Log:
Removed doxyme. Everything in there was documented already. However, I am not
done with the firewall/pisa.c file yet
Modified:
D firewall/pisa.c.doxyme
=== removed file 'firewall/pisa.c.doxyme'
--- firewall/pisa.c.doxyme 2010-02-11 17:34:50 +0000
+++ firewall/pisa.c.doxyme 1970-01-01 00:00:00 +0000
@@ -1,53 +0,0 @@
-/**
- * @file firewall/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.
-
-
-
-
-/**
- * pisa_init
- *
- *
- * @param simplecsearch
- * @return
- */
Other related posts:
- » [hipl-commit] [trunk] Rev 3671: Removed doxyme. Everything in there was documented already. However, I am not done with the firewall/pisa.c file yet - Tobias Heer
