[hipl-commit] [trunk] Rev 3669: removed doxygen markers for already doxified files
- From: Rene Hummen <rene.hummen@xxxxxxxxxxxxxxxxx>
- To: hipl-commit@xxxxxxxxxxxxx
- Date: Thu, 18 Feb 2010 00:18:23 +0200
Committer: Rene Hummen <rene.hummen@xxxxxxxxxxxxxxxxx>
Date: Wed Feb 17 23:17:57 2010 +0100
Revision: 3669
Revision-id: rene.hummen@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Branch nick: trunk
Log:
removed doxygen markers for already doxified files
Modified:
D firewall/helpers.c.doxyme
D firewall/hslist.c.doxyme
D firewall/opptcp.c.doxyme
D firewall/rule_management.c.doxyme
D firewall/user_ipsec_fw_msg.c.doxyme
=== removed file 'firewall/helpers.c.doxyme'
--- firewall/helpers.c.doxyme 2010-02-11 17:34:50 +0000
+++ firewall/helpers.c.doxyme 1970-01-01 00:00:00 +0000
@@ -1,62 +0,0 @@
-/**
- * @file firewall/helpers.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.
-
-
-
-
-/**
- * addr_to_numeric
- *
- *
- * @param addrp
- * @return
- */
-
-
-/**
- * numeric_to_addr
- *
- *
- * @param num
- * @return
- */
=== removed file 'firewall/hslist.c.doxyme'
--- firewall/hslist.c.doxyme 2010-02-14 12:32:17 +0000
+++ firewall/hslist.c.doxyme 1970-01-01 00:00:00 +0000
@@ -1,99 +0,0 @@
-/**
- * @file firewall/hslist.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.
-
-
-
-
-/**
- * alloc_slist
- *
- *
- * @param void
- * @return
- */
-
-
-/**
- * append_to_slist
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * free_slist
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * remove_from_slist
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * remove_link_slist
- *
- *
- * @param list
- * @param link
- * @return
- */
-
-
-/**
- * slist_last
- *
- *
- * @param autogen.sh
- * @return
-r*/
=== removed file 'firewall/opptcp.c.doxyme'
--- firewall/opptcp.c.doxyme 2010-02-11 17:34:50 +0000
+++ firewall/opptcp.c.doxyme 1970-01-01 00:00:00 +0000
@@ -1,77 +0,0 @@
-/**
- * @file firewall/opptcp.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_fw_examine_incoming_tcp_packet
- *
- *
- * @param hdr
- * @param ip_version
- * @param header_size
- * @return
- */
-
-
-/**
- * hip_request_send_tcp_packet
- *
- *
- * @param hdr
- * @param packet_size
- * @param ip_version
- * @param addHit
- * @param addOption
- * @return
- */
-
-
-/**
- * tcp_packet_has_i1_option
- *
- *
- * @param autogen.sh
- * @return
- */
=== removed file 'firewall/rule_management.c.doxyme'
--- firewall/rule_management.c.doxyme 2010-02-11 17:34:50 +0000
+++ firewall/rule_management.c.doxyme 1970-01-01 00:00:00 +0000
@@ -1,315 +0,0 @@
-/**
- * @file firewall/rule_management.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.
-
-
-
-
-/**
- * copy_hit_option
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * copy_int_option
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * copy_rule
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * copy_state_option
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * copy_string_option
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * delete_rule
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * flush
- *
- *
- * @param hook
- * @return
- */
-
-
-/**
- * free_rule
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * free_string_option
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * get_rule_list
- *
- *
- * @param hook
- * @return
- */
-
-
-/**
- * hit_options_equal
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * insert_rule
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * int_options_equal
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * list_rules
- *
- *
- * @param hook
- * @return
- */
-
-
-/**
- * load_dsa_file
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * load_rsa_file
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * parse_hi
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * parse_hit
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * parse_if
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * parse_rule
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * parse_state
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * parse_type
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * print_rule
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * read_file
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * read_rules
- *
- *
- * @param hook
- * @return
- */
-
-
-/**
- * read_rules_exit
- *
- *
- * @param hook
- * @return
- */
-
-
-/**
- * rules_equal
- *
- *
- * @param rule1
- * @param rule2
- * @return
- */
-
-
-/**
- * set_rule_list
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * state_options_equal
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * string_options_equal
- *
- *
- * @param autogen.sh
- * @return
- */
=== removed file 'firewall/user_ipsec_fw_msg.c.doxyme'
--- firewall/user_ipsec_fw_msg.c.doxyme 2010-02-11 17:34:50 +0000
+++ firewall/user_ipsec_fw_msg.c.doxyme 1970-01-01 00:00:00 +0000
@@ -1,80 +0,0 @@
-/**
- * @file firewall/user_ipsec_fw_msg.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.
-
-
-
-
-/**
- * handle_sa_add_request
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * handle_sa_delete_request
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * handle_sa_flush_all_request
- *
- *
- * @param autogen.sh
- * @return
- */
-
-
-/**
- * send_userspace_ipsec_to_hipd
- *
- *
- * @param activate
- * @return
- */
Other related posts:
- » [hipl-commit] [trunk] Rev 3669: removed doxygen markers for already doxified files - Rene Hummen
