hipl-core team mailing list archive
-
hipl-core team
-
Mailing list archive
-
Message #00101
[Branch ~hipl-core/hipl/trunk] Rev 4919: Don't unneccesarily repeat function name in doxygen comments.
------------------------------------------------------------
revno: 4919
committer: Christof Mroz <christof.mroz@xxxxxxxxxxxxxx>
branch nick: trunk
timestamp: Sun 2010-08-29 18:24:14 +0200
message:
Don't unneccesarily repeat function name in doxygen comments.
As requested by Miika:
Subject: Re: [Hipl-core] [Branch ~hipl-core/hipl/trunk] Rev 4916: Comment typo.
Date: Thu, 26 Aug 2010 10:29:00 +0300
From: Miika Komu <mkomu@xxxxxxxxx>
To: hipl-core@xxxxxxxxxxxxxxxxxxx
On 08/25/2010 07:50 PM, noreply@xxxxxxxxxxxxx wrote:
Hi,
I would actually suggest to remove the unnecessary function names from
all doxygen comments. It looks silly in doxygen and has really no
purpose . Also, forgetting to update the duplicate name does not cause
any doxygen warning whatsoever.
http://hipl.hiit.fi/hipl/doxygen/
=== modified file 'hipd/close.c'
--- hipd/close.c 2010-08-19 09:32:20 +0000
+++ hipd/close.c 2010-08-25 16:48:22 +0000
@@ -347,7 +347,7 @@
}
/**
- * hip_close_create_response
+ * hip_close_send_response
*
* Send a before generated CLOSE_ACK packet.
*
modified:
hipd/cert.c
hipd/close.c
hipd/esp_prot_light_update.c
hipd/hip_socket.c
hipd/hiprelay.c
hipd/hit_to_ip.c
hipd/input.c
hipd/keymat.c
hipd/maintenance.c
hipd/nsupdate.c
hipd/oppipdb.c
hipd/pkt_handling.c
hipd/user.c
lib/core/builder.c
lib/core/certtools.c
lib/core/debug.c
lib/core/hit.c
lib/modularization/lmod.c
lib/tool/nlink.c
modules/update/hipd/update.c
--
lp:hipl
https://code.launchpad.net/~hipl-core/hipl/trunk
Your team HIPL core team is subscribed to branch lp:hipl.
To unsubscribe from this branch go to https://code.launchpad.net/~hipl-core/hipl/trunk/+edit-subscription
=== modified file 'hipd/cert.c'
--- hipd/cert.c 2010-08-20 14:34:13 +0000
+++ hipd/cert.c 2010-08-29 16:24:14 +0000
@@ -63,8 +63,8 @@
***************************************************************************/
/**
- * hip_cert_spki_sign - Function that signs the cert sequence and
- * creates the public key sequence and the signature sequence
+ * Function that signs the cert sequence and creates the public key
+ * sequence and the signature sequence
*
* @param msg points to the msg gotten from "client" that should
* contain HIP_PARAM_CERT_SPKI_INFO
=== modified file 'hipd/close.c'
--- hipd/close.c 2010-08-25 16:48:22 +0000
+++ hipd/close.c 2010-08-29 16:24:14 +0000
@@ -233,8 +233,6 @@
}
/**
- * hip_close_check_packet
- *
* Check whether a received control packet is valid or not.
*
* @param packet_type The packet type of the control message (RFC 5201, 5.3.)
@@ -289,8 +287,6 @@
}
/**
- * hip_close_create_response
- *
* Create an response (CLOSE_ACK) for a received CLOSE packet.
*
* @param packet_type The packet type of the control message (RFC 5201, 5.3.)
@@ -347,8 +343,6 @@
}
/**
- * hip_close_send_response
- *
* Send a before generated CLOSE_ACK packet.
*
* @param packet_type The packet type of the control message (RFC 5201, 5.3.)
@@ -413,8 +407,6 @@
}
/**
- * hip_close_ack_check_packet
- *
* Check whether a received CLOSE_ACK packet is valid or not.
*
* @param packet_type The packet type of the control message (RFC 5201, 5.3.)
@@ -483,8 +475,6 @@
}
/**
- * hip_close_ack_handle_packet
- *
* Handle a received and checked CLOSE_ACK packet. If a hadb entry exists, the
* host association state will be set to HIP_STATE_CLOSED.
*
=== modified file 'hipd/esp_prot_light_update.c'
--- hipd/esp_prot_light_update.c 2010-08-19 09:32:20 +0000
+++ hipd/esp_prot_light_update.c 2010-08-29 16:24:14 +0000
@@ -205,8 +205,6 @@
}
/**
- * esp_prot_handle_light_update
- *
* Handles an HHL-based update message
*
* @param packet_type the packet type
=== modified file 'hipd/hip_socket.c'
--- hipd/hip_socket.c 2010-08-25 09:06:43 +0000
+++ hipd/hip_socket.c 2010-08-29 16:24:14 +0000
@@ -190,10 +190,6 @@
hip_register_socket(hip_nl_route.fd, &hip_handle_nl_route_sock, 10500);
}
-/**
- * hip_register_socket
- *
- */
int hip_register_socket(int socketfd,
int (*func_ptr)(struct hip_packet_context *ctx),
const uint16_t priority)
@@ -221,10 +217,6 @@
return err;
}
-/**
- * hip_get_highest_descriptor
- *
- */
int hip_get_highest_descriptor(void)
{
int highest_descriptor = 0;
@@ -243,10 +235,6 @@
return highest_descriptor;
}
-/**
- * hip_prepare_fd_set
- *
- */
void hip_prepare_fd_set(fd_set *read_fdset)
{
hip_ll_node_t *iter = NULL;
@@ -262,10 +250,6 @@
}
}
-/**
- * hip_run_socket_handles
- *
- */
void hip_run_socket_handles(fd_set *read_fdset, struct hip_packet_context *ctx)
{
hip_ll_node_t *iter = NULL;
=== modified file 'hipd/hiprelay.c'
--- hipd/hiprelay.c 2010-08-20 14:34:13 +0000
+++ hipd/hiprelay.c 2010-08-29 16:24:14 +0000
@@ -468,8 +468,6 @@
}
/**
- * hip_relht_maintenance
- *
* @brief Clear the expired records from the relay hashtable.
*
* Periodic maintenance function of the hip relay. This function should be
=== modified file 'hipd/hit_to_ip.c'
--- hipd/hit_to_ip.c 2010-08-19 09:32:20 +0000
+++ hipd/hit_to_ip.c 2010-08-29 16:24:14 +0000
@@ -50,8 +50,6 @@
int hip_hit_to_ip_status = 0;
/**
- * hip_set_hit_to_ip_status
- *
* This function is an interface to turn on/off locators lookup in hit-to-ip domain
*
* @param status 0 unless locator lookups in hit-to-ip domain wanted, 1 otherwise
@@ -62,8 +60,6 @@
}
/**
- * hip_get_hit_to_ip_status
- *
* This function is an interface to check if locators lookup in hit-to-ip domain if wanted
*
* @return 0 unless locator lookups in hit-to-ip domain wanted, 1 otherwise
@@ -80,8 +76,6 @@
char *hip_hit_to_ip_zone = NULL;
/**
- * hip_hit_to_ip_set
- *
* Set the zone for hit-to-ip domain lookups
*
* @param zone domain as a string, e.g. "hit-to-ip.infrahip.net"
@@ -103,8 +97,6 @@
};
/**
- * hip_get_hit_to_ip_hostname
- *
* returns "5.7.d.1.c.c.8.d.0.6.3.b.a.4.6.2.5.0.5.2.e.4.7.5.e.1.0.0.1.0.0.2.hit-to-ip.infrahip.net" for 2001:1e:574e:2505:264a:b360:d8cc:1d75
*
* @param hit HIT as a string
@@ -138,8 +130,6 @@
}
/**
- * hip_hit_to_ip
- *
* checks for ip address for hit preferring IPv4 one
*
* @param hit HIT to look locators for
=== modified file 'hipd/input.c'
--- hipd/input.c 2010-08-20 14:34:13 +0000
+++ hipd/input.c 2010-08-29 16:24:14 +0000
@@ -680,8 +680,6 @@
}
/**
- * hip_check_r1
- *
* Check a received R1 control packet.
*
* @param packet_type The packet type of the control message (RFC 5201, 5.3.)
@@ -977,8 +975,6 @@
return err;
}
/**
- * hip_handle_i2_in_i2_sent
- *
* Checks wether the received I2 packet in state I2-SENT should be droppped, or
* not. If the packet should be dropped, the error flag is set to 1.
*
@@ -1007,8 +1003,6 @@
}
/**
- * hip_check_r2
- *
* Check a received R2 control packet.
*
* @param packet_type The packet type of the control message (RFC 5201, 5.3.)
@@ -1081,8 +1075,6 @@
}
/**
- * hip_handle_r2
- *
* Handle an incoming R2 packet.
*
* @param packet_type The packet type of the control message (RFC 5201, 5.3.)
@@ -1258,8 +1250,6 @@
}
/**
- * hip_check_i1
- *
* Check a received I1 control packet.
*
* @param packet_type The packet type of the control message (RFC 5201, 5.3.)
@@ -1406,8 +1396,6 @@
}
/**
- * hip_check_i2
- *
* Check a received I2 control packet.
*
* @param packet_type The packet type of the control message (RFC 5201, 5.3.)
@@ -1908,8 +1896,6 @@
}
/**
- * hip_check_notify
- *
* Check an incoming NOTIFY packet.
*
* @param packet_type The packet type of the control message (RFC 5201, 5.3.)
=== modified file 'hipd/keymat.c'
--- hipd/keymat.c 2010-07-07 16:42:17 +0000
+++ hipd/keymat.c 2010-08-29 16:24:14 +0000
@@ -115,7 +115,7 @@
}
/**
- * hip_make_keymat - generate HIP keying material
+ * generate HIP keying material
* @param kij Diffie-Hellman Kij (as in the HIP drafts)
* @param kij_len the length of the Kij material
* @param keymat pointer to a keymat structure which will be updated according
@@ -215,7 +215,7 @@
}
/**
- * hip_keymat_draw - draw keying material
+ * draw keying material
* @param keymat pointer to the keymat structure which contains information
* about the actual
* @param len size of keymat structure
@@ -241,7 +241,7 @@
}
/**
- * hip_keymat_draw_and_copy - draw keying material and copy it to the given buffer
+ * draw keying material and copy it to the given buffer
* @param dst destination buffer
* @param keymat pointer to the keymat structure which contains information
* about the actual
=== modified file 'hipd/maintenance.c'
--- hipd/maintenance.c 2010-07-16 18:56:20 +0000
+++ hipd/maintenance.c 2010-08-29 16:24:14 +0000
@@ -186,8 +186,6 @@
}
/**
- * hip_register_maint_function
- *
* Register a maintenance function. All maintenance functions are called during
* the periodic maintenance cycle.
*
@@ -224,8 +222,6 @@
}
/**
- * hip_unregister_maint_function
- *
* Remove a maintenance function from the list.
*
* @param *maint_function Pointer to the function which should be unregistered.
@@ -240,8 +236,6 @@
}
/**
- * hip_run_maint_functions
- *
* Run all maintenance functions.
*
* @return Success = 0
@@ -264,8 +258,6 @@
}
/**
- * hip_uninit_maint_functions
- *
* Free the memory used for storage of maintenance functions.
*
*/
=== modified file 'hipd/nsupdate.c'
--- hipd/nsupdate.c 2010-08-10 07:26:42 +0000
+++ hipd/nsupdate.c 2010-08-29 16:24:14 +0000
@@ -74,8 +74,6 @@
int hip_nsupdate_status = 0;
/**
- * hip_set_nsupdate_status
- *
* This function is an interface to turn on/off DNS updates
*
* @param status 0 unless DNS updates wanted, 1 otherwise
@@ -87,8 +85,6 @@
}
/**
- * hip_get_nsupdate_status
- *
* This function is an interface to check if DNS updates are wanted
*
* @return 0 unless DNS updates wanted, 1 otherwise
=== modified file 'hipd/oppipdb.c'
--- hipd/oppipdb.c 2010-07-29 09:07:47 +0000
+++ hipd/oppipdb.c 2010-08-29 16:24:14 +0000
@@ -67,7 +67,6 @@
}
/**
- * hip_oppipdb_match_ip:
* Compares two ip addresses using their hashes
*
* @param ptr1: pointer to the first ip address to compare
=== modified file 'hipd/pkt_handling.c'
--- hipd/pkt_handling.c 2010-07-07 16:42:17 +0000
+++ hipd/pkt_handling.c 2010-08-29 16:24:14 +0000
@@ -53,8 +53,6 @@
static hip_ll_t *hip_handle_functions[HIP_MAX_PACKET_TYPE][HIP_MAX_HA_STATE];
/**
- * hip_register_handle_function
- *
* Register a function for handling of the specified combination from packet
* type and host association state.
*
@@ -105,8 +103,6 @@
}
/**
- * hip_run_handle_functions
- *
* Run all handle functions for specified combination from packet type and host
* association state.
*
@@ -153,8 +149,6 @@
}
/**
- * hip_uninit_handle_functions
- *
* Free the memory used for storage of handle functions.
*
*/
=== modified file 'hipd/user.c'
--- hipd/user.c 2010-08-25 09:06:43 +0000
+++ hipd/user.c 2010-08-29 16:24:14 +0000
@@ -172,8 +172,6 @@
}
/**
- * hip_uninit_handle_functions
- *
* Free the memory used for storage of handle functions.
*
*/
=== modified file 'lib/core/builder.c'
--- lib/core/builder.c 2010-08-20 14:34:13 +0000
+++ lib/core/builder.c 2010-08-29 16:24:14 +0000
@@ -176,7 +176,7 @@
}
/**
- * hip_msg_alloc - allocate and initialize a HIP packet
+ * Allocate and initialize a HIP packet
*
* Return: initialized HIP packet if successful, NULL on error.
*/
@@ -578,7 +578,7 @@
}
/**
- * hip_check_network_msg_type - check the type of the network message
+ * Check the type of the network message
*
* @param msg pointer to the message
* @return 1 if the message type is valid, or 0 if the message type is
=== modified file 'lib/core/certtools.c'
--- lib/core/certtools.c 2010-08-19 09:32:20 +0000
+++ lib/core/certtools.c 2010-08-29 16:24:14 +0000
@@ -54,7 +54,7 @@
*******************************************************************************/
/**
- * hip_cert_spki_lib_verify - Function that verifies the signature in
+ * Function that verifies the signature in
* the given SPKI cert sent by the "client"
*
* @param cert points to hip_cert_spki_info that is going to be verified
@@ -369,9 +369,8 @@
}
/**
- * hip_cert_spki_build_cert - Function to build the basic cert object
- * of SPKI clears public-key object and signature in
- * hip_cert_spki_header
+ * Function to build the basic cert object of SPKI clears public-key
+ * object and signature in hip_cert_spki_header
*
* @param minimal_content holds the struct hip_cert_spki_header
* containing the minimal needed information for
@@ -393,7 +392,7 @@
}
/**
- * hip_cert_spki_inject - Function for injecting objects to cert object
+ * Function for injecting objects to cert object
*
* @param to hip_cert_spki_info containing the char table where to insert
* @param after is a char pointer for the regcomp after which the inject happens
@@ -438,7 +437,7 @@
}
/**
- * hip_cert_spki_create_cert - Function to build the create minimal SPKI cert
+ * Function to build the create minimal SPKI cert
*
* @param content holds the struct hip_cert_spki_info containing
* the minimal needed information for cert object,
@@ -589,8 +588,8 @@
}
/**
- * hip_cert_spki_char2certinfo - Function that takes the cert in single char table
- * and constructs hip_cert_spki_info from it
+ * Function that takes the cert in single char table and constructs
+ * hip_cert_spki_info from it
*
* @param from char pointer to the whole certificate
* @param to hip_cert_spki_info containing the char table where to insert
@@ -641,8 +640,8 @@
}
/**
- * hip_cert_spki_send_to_verification - Function that sends the given
- * hip_cert_spki_info to the daemon to verification
+ * Function that sends the given hip_cert_spki_info to the daemon to
+ * verification
*
* @param to_verification is the cert to be verified
*
@@ -687,8 +686,7 @@
******************************************************************************/
/**
- * hip_cert_x509v3_request_certificate - Function that requests for a
- * certificate from daemon and gives it back
+ * Function that requests for a certificate from daemon and gives it back.
*
* @param subject is the subjects HIT
*
@@ -732,8 +730,8 @@
}
/**
- * hip_cert_x509v3_request_verification - Function that requests for a
- * verification of a certificate from daemon and tells the result
+ * Function that requests for a verification of a certificate from
+ * daemon and tells the result.
*
* @param certificate is pointer to a certificate to be verified
* @param len is the length of the cert in certificate parameter in bytes
@@ -784,8 +782,7 @@
*******************************************************************************/
/**
- * hip_cert_read_conf_section - Function that reads configuration
- * section from HIP_CERT_CONF_PATH,
+ * Function that reads configuration section from HIP_CERT_CONF_PATH.
*
* @param section_name a char pointer pointing to the name of the section to be retrieved
* @param conf pointer to CONF struct that will point to the default configuration
@@ -824,7 +821,7 @@
}
/**
- * hip_cert_open_conf - Function that opens an configuration file from HIP_CERT_CONF_PATH,
+ * Function that opens an configuration file from HIP_CERT_CONF_PATH.
*
* @return CONF pointer if ok and NULL if error or unsuccesfull.
*/
@@ -844,7 +841,7 @@
}
/**
- * hip_cert_free_conf - Function that frees the memory of a allocated configuration
+ * Function that frees the memory of a allocated configuration.
*
* @param conf pointer to the to be freed configuration
*
@@ -858,7 +855,7 @@
}
/**
- * hip_cert_regex - Function that wraps regular expression stuff and gives the answer :)
+ * Function that wraps regular expression stuff and gives the answer :)
*
* @param what is a char pointer to the rule used in the search (POSIX)
* @param from where are we looking for it char pointer
=== modified file 'lib/core/debug.c'
--- lib/core/debug.c 2010-08-19 09:32:20 +0000
+++ lib/core/debug.c 2010-08-29 16:24:14 +0000
@@ -743,7 +743,7 @@
}
/**
- * hip_print_locator - print a locator
+ * Print a locator.
* @param file
* @param debug_level
* @param line
=== modified file 'lib/core/hit.c'
--- lib/core/hit.c 2010-07-16 15:26:02 +0000
+++ lib/core/hit.c 2010-08-29 16:24:14 +0000
@@ -94,7 +94,7 @@
}
/**
- * hip_hash_hit - calculate a hash from a HIT
+ * calculate a hash from a HIT
*
* @param ptr pointer to a HIT
*
=== modified file 'lib/modularization/lmod.c'
--- lib/modularization/lmod.c 2010-07-04 17:54:18 +0000
+++ lib/modularization/lmod.c 2010-08-29 16:24:14 +0000
@@ -83,8 +83,6 @@
static uint16_t num_disabled_modules = 0;
/**
- * lmod_init_state
- *
* Initializes a new data structure for storage of references to state items.
* This data structure consists of a pointer set and can be mentioned as global
* state.
@@ -112,8 +110,6 @@
}
/**
- * lmod_register_state_init_function
- *
* Registers a new state initialization function. These functions are called,
* when a new host association database entry is created.
*
@@ -132,8 +128,6 @@
}
/**
- * lmod_init_state_items
- *
* Initialize all registered state items. This function is called, when a new
* host association database entry is created.
*
@@ -154,8 +148,6 @@
}
/**
- * lmod_get_state_item_id
- *
* Retrieve a void pointer to a state variable from the global state set using
* the state item name.
*
@@ -179,8 +171,6 @@
}
/**
- * lmod_get_state_item_by_id
- *
* Returns a void pointer to a state item from the global state set using
* the id (index number).
*
@@ -196,8 +186,6 @@
}
/**
- * lmod_get_state_item
- *
* Returns a void pointer to a state item from the global state set using
* the string identifier.
*
@@ -217,8 +205,6 @@
/**
- * lmod_add_state_item
- *
* Registers a new state item to the global state. The state item can be of any
* type. This function stores a reference to the new state item.
*
@@ -252,8 +238,6 @@
}
/**
- * lmod_uninit_state
- *
* Free all allocated memory for storage of the global state set.
*
* @param state Pointer to the global state.
@@ -274,8 +258,6 @@
}
/**
- * lmod_register_function
- *
* Register a function to the specified list according their priority.
*
* @param *list Pointer to the list if already exist, NULL otherwise.
@@ -325,8 +307,6 @@
}
/**
- * lmod_unregister_function
- *
* Unregister a function from the specified list.
*
* @param *list Pointer to the list from which the function should be removed.
@@ -356,8 +336,6 @@
}
/**
- * lmod_disable_module
- *
* Disable the module with the provide name. The initialization functions of
* disabled modules will not be executed. Therefore the functionality of these
* modules should be completely disabled.
@@ -384,8 +362,6 @@
}
/**
- * lmod_module_disabled
- *
* Check whether a certain module is disabled.
*
* @note This function uses string compares. Therefore you should call this
@@ -410,8 +386,6 @@
}
/**
- * lmod_uninit_disabled_modules
- *
* Free all allocated memory for storage of disabled modules.
*
*/
@@ -430,8 +404,6 @@
}
/**
- * lmod_packet_type_exists
- *
* Check whether a certain packet type was already registered.
*
* @note The return value is not 0 (FALSE), if the packet type not exists.
@@ -460,8 +432,6 @@
}
/**
- * lmod_register_packet_type
- *
* Register a new packet type and the corresponding identifier. Each module
* introducing a new packet type should register it using this function.
*
@@ -513,8 +483,6 @@
}
/**
- * lmod_free_packet_entry
- *
* Free allocated memory for one entry of the packet type list.
*
*/
@@ -526,8 +494,6 @@
}
/**
- * lmod_uninit_packet_types
- *
* Free all allocated memory for storage of the packet type list.
*
* @note Call this function, if you have added packet types.
=== modified file 'lib/tool/nlink.c'
--- lib/tool/nlink.c 2010-07-16 18:56:20 +0000
+++ lib/tool/nlink.c 2010-08-29 16:24:14 +0000
@@ -1439,8 +1439,7 @@
}
/**
- * xfrm_fill_selector - fill in the selector.
- * Selector is bound to HITs
+ * Fill in the selector. Selector is bound to HITs.
*
* @param sel pointer to xfrm_selector to be filled in
* @param id_our Source HIT or LSI, if the last is defined
=== modified file 'modules/update/hipd/update.c'
--- modules/update/hipd/update.c 2010-08-20 16:38:55 +0000
+++ modules/update/hipd/update.c 2010-08-29 16:24:14 +0000
@@ -790,8 +790,6 @@
}
/**
- * hip_update_manual_update
- *
* Thin wrapper function around hip_send_locators_to_all_peers. Needed for
* registration as user message handle function.
*
@@ -859,8 +857,6 @@
}
/**
- * hip_update_check_packet
- *
* Check a received UPDATE packet.
*
* @param packet_type The packet type of the control message (RFC 5201, 5.3.)
@@ -933,8 +929,6 @@
}
/**
- * hip_update_handle_packet
- *
* Process an received and checked UPDATE packet.
*
* @param packet_type the packet type
Follow ups
