- testcases added to module testcases

Source/charon/Doxyfile

@@ -73,7 +73,7 @@ WARN_LOGFILE =
 INPUT = ./
 FILE_PATTERNS = *.h
 RECURSIVE = YES
-EXCLUDE = testcases
+EXCLUDE = 
 EXCLUDE_SYMLINKS = NO
 EXCLUDE_PATTERNS = 
 EXAMPLE_PATH = 

Source/charon/definitions.h

@@ -80,6 +80,13 @@
  * @ingroup encoding
  */
 
+
+/**
+ * @addtogroup testcases
+ * 
+ * Testcases used to test the different classes in seperate module tests.
+ */
+
 /**
  * @addtogroup transforms
  * 

Source/charon/testcases/aes_cbc_crypter_test.c

@@ -1,7 +1,7 @@
 /**
  * @file aes_cbc_crypter_test.c
  * 
- * @brief Tests the aes_cbc_crypter_t class.
+ * @brief Tests for the aes_cbc_crypter_t class.
  * 
  */
 

Source/charon/testcases/aes_cbc_crypter_test.h

@@ -1,7 +1,7 @@
 /**
  * @file aes_cbc_crypter_test.h
  * 
- * @brief Tests the aes_cbc_crypter_t class.
+ * @brief Tests for the aes_cbc_crypter_t class.
  * 
  */
 
@@ -30,6 +30,8 @@
  * @brief Test function used to test the aes_cbc_crypter_t class.
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_aes_cbc_crypter(tester_t *tester);
 

Source/charon/testcases/diffie_hellman_test.c

@@ -1,7 +1,7 @@
 /**
  * @file diffie_hellman_test.c
  * 
- * @brief Tests to test the Diffie Hellman object diffie_hellman_t
+ * @brief Tests for the diffie_hellman_t class.
  * 
  */
 

Source/charon/testcases/diffie_hellman_test.h

@@ -1,7 +1,7 @@
 /**
  * @file diffie_hellman_test.h
  * 
- * @brief Tests to test the Diffie Hellman object diffie_hellman_t
+ * @brief Tests for the diffie_hellman_t class.
  * 
  */
 
@@ -26,11 +26,11 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function used to test the diffie_hellman_t functionality
+ * @brief Test function used to test the diffie_hellman_t functionality.
- * 
- * Tests are performed using one thread
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_diffie_hellman(tester_t *tester);
 

Source/charon/testcases/event_queue_test.c

@@ -1,7 +1,7 @@
 /**
  * @file event_queue_test.h
  *
- * @brief Tests to test the Event-Queue type event_queue_t
+ * @brief Tests for the event_queue_t class.
  *
  */
 

Source/charon/testcases/event_queue_test.h

@@ -26,11 +26,13 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function used to test the event_queue functionality
+ * @brief Test function used to test the event_queue functionality.
  * 
- * Tests are performed using one thread
+ * Tests are performed using one thread.
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_event_queue(tester_t *tester);
 

Source/charon/testcases/generator_test.c

@@ -1,7 +1,7 @@
 /**
- * @file generator.h
+ * @file generator_test.c
  * 
- * @brief Tests to test the Generator class generator_t
+ * @brief Tests for the generator_t class.
  * 
  */
 

Source/charon/testcases/generator_test.h

@@ -1,7 +1,7 @@
 /**
  * @file generator.h
  * 
- * @brief Tests to test the Generator class generator_t
+ * @brief Tests for the generator_t class.
  * 
  */
 
@@ -26,67 +26,75 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function used to test the generator with header payload
+ * @brief Test function used to test the generator with header payload.
  * 
- *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_generator_with_header_payload(tester_t *tester);
 
 /**
- * @brief Test function used to test the generator with transform attribute payload
+ * @brief Test function used to test the generator with transform attribute payload.
- * 
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_generator_with_transform_attribute(tester_t *tester);
 
 
 /**
- * @brief Test function used to test the generator with transform substructure payload
+ * @brief Test function used to test the generator with transform substructure payload.
- * 
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_generator_with_transform_substructure(tester_t *tester);
 
 /**
- * @brief Test function used to test the generator with proposal substructure payload
+ * @brief Test function used to test the generator with proposal substructure payload.
- * 
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_generator_with_proposal_substructure(tester_t *tester);
 
 /**
- * @brief Test function used to test the generator with SA payload
+ * @brief Test function used to test the generator with SA payload.
  * 
- *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_generator_with_sa_payload(tester_t *tester);
 
 /**
- * @brief Test function used to test the generator with KE payload
+ * @brief Test function used to test the generator with KE payload.
- * 
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_generator_with_ke_payload(tester_t *tester);
 
 /**
- * @brief Test function used to test the generator with Notify payload
+ * @brief Test function used to test the generator with Notify payload.
- * 
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_generator_with_notify_payload(tester_t *tester);
 
 /**
- * @brief Test function used to test the generator with Nonce payload
+ * @brief Test function used to test the generator with Nonce payload.
  * 
- *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_generator_with_nonce_payload(tester_t *tester);
 

Source/charon/testcases/hasher_test.c

@@ -1,7 +1,7 @@
 /**
- * @file md5_hasher_test.h
+ * @file hasher_test.h
  * 
- * @brief Tests the md5 hasher 
+ * @brief Tests for the hasher_t classes.
  * 
  */
 

Source/charon/testcases/hasher_test.h

@@ -1,7 +1,7 @@
 /**
  * @file hasher_test.h
  * 
- * @brief Tests the hashers 
+ * @brief Tests for the hasher_t classes.
  * 
  */
 
@@ -29,16 +29,20 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function used to test the sha1-hasher functionality
+ * @brief Test function used to test the SHA1-hasher functionality.
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_sha1_hasher(tester_t *tester);
 
 /**
- * @brief Test function used to test the md5-hasher functionality
+ * @brief Test function used to test the Md5-hasher functionality.
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_md5_hasher(tester_t *tester);
 

Source/charon/testcases/hmac_signer_test.c

@@ -1,7 +1,7 @@
 /**
  * @file hmac_signer_test.c
  * 
- * @brief Tests the hmac SHA1 and MD5 signer class hmac_signer_t 
+ * @brief Tests for the hmac_signer_t class.
  * 
  */
 

Source/charon/testcases/hmac_signer_test.h

@@ -1,7 +1,7 @@
 /**
  * @file hmac_signer_test.h
  * 
- * @brief Tests the hmac SHA1 and MD5 signer class hmac_signer_t 
+ * @brief Tests for the hmac_signer_t class.
  * 
  */
 
@@ -29,6 +29,8 @@
  * @brief Test function used to test the hmac sign functionality using MD5.
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_hmac_md5_signer(tester_t *tester);
 
@@ -36,6 +38,8 @@ void test_hmac_md5_signer(tester_t *tester);
  * @brief Test function used to test the hmac sign functionality using SHA1.
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_hmac_sha1_signer(tester_t *tester);
 

Source/charon/testcases/hmac_test.c

@@ -1,7 +1,7 @@
 /**
  * @file hmac_test.h
  * 
- * @brief Tests the hmac class 
+ * @brief Tests for the hmac_t class.
  * 
  */
 

Source/charon/testcases/hmac_test.h

@@ -1,7 +1,7 @@
 /**
  * @file hmac_test.h
  * 
- * @brief Tests the hmac class
+ * @brief Tests for the hmac_t class.
  * 
  */
 
@@ -28,17 +28,21 @@
 
 /**
  * @brief Test function used to test the hmac functionality
- * using sha1.
+ * using SHA1.
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_hmac_sha1(tester_t *tester);
 
 /**
  * @brief Test function used to test the hmac functionality
- * using md5.
+ * using MD5.
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_hmac_md5(tester_t *tester);
 

Source/charon/testcases/ike_sa_id_test.c

@@ -1,7 +1,7 @@
 /**
  * @file ike_sa_id_test.c
  * 
- * @brief Tests to test the IKE_SA Identifier class ike_sa_id_test_t
+ * @brief Tests for the ike_sa_id_t class.
  * 
  */
 

Source/charon/testcases/ike_sa_id_test.h

@@ -1,7 +1,7 @@
 /**
  * @file ike_sa_id_test.h
  * 
- * @brief Tests to test the IKE_SA Identifier class ike_sa_id_test_t
+ * @brief Tests for the ike_sa_id_t class.
  * 
  */
 
@@ -26,12 +26,14 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function used to test the ike_sa_id functionality
+ * @brief Test function used to test the ike_sa_id functionality.
  * 
  * Tests are performed using one thread to test the 
  * features of the ike_sa_id_t.
  *
  * @param tester associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_ike_sa_id(tester_t *tester);
 

Source/charon/testcases/ike_sa_manager_test.c

@@ -1,7 +1,7 @@
 /**
  * @file ike_sa_manager_test.c
  * 
- * @brief Tests to test the IKE_SA-Manager type ike_sa_manager_t
+ * @brief Tests for the ike_sa_manager_t class.
  * 
  */
 

Source/charon/testcases/ike_sa_manager_test.h

@@ -1,7 +1,7 @@
 /**
  * @file ike_sa_manager_test.c
  *
- * @brief Tests to test the IKE_SA-Manager type ike_sa_manager_t
+ * @brief Tests for the ike_sa_manager_t class.
  *
  */
 
@@ -26,10 +26,11 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function used to test the ike_sa_manager_t functionality
+ * @brief Test function used to test the ike_sa_manager_t functionality.
- *
  *
  * @param tester associated tester_t object
+ * 
+ * @ingroup testcases
  */
 void test_ike_sa_manager(tester_t *tester);
 

Source/charon/testcases/ike_sa_test.c

@@ -1,7 +1,7 @@
 /**
  * @file ike_sa_test.c
  * 
- * @brief Tests to test the IKE_SA type ike_sa_t
+ * @brief Tests for the ike_sa_t class.
  * 
  */
 

Source/charon/testcases/ike_sa_test.h

@@ -1,7 +1,7 @@
 /**
  * @file ike_sa_test.h
  *
- * @brief Tests to test the IKE_SA type ike_sa_t
+ * @brief Tests for the ike_sa_t class.
  *
  */
 
@@ -26,10 +26,11 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function used to test the ike_sa_t functionality
+ * @brief Test function used to test the ike_sa_t functionality.
- *
  *
  * @param tester associated tester_t object
+ * 
+ * @ingroup testcases
  */
 void test_ike_sa(tester_t *tester);
 

Source/charon/testcases/job_queue_test.c

@@ -1,7 +1,7 @@
 /**
  * @file job_queue_test.c
  *
- * @brief Tests to test the Job-Queue type job_queue_t
+ * @brief Tests for the job_queue_t class.
  *
  */
 

Source/charon/testcases/job_queue_test.h

@@ -1,7 +1,7 @@
 /**
  * @file job_queue_test.h
  * 
- * @brief Tests to test the Job-Queue type job_queue_t
+ * @brief Tests for the job_queue_test_t class.
  * 
  */
 
@@ -26,12 +26,14 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function used to test the job_queue functionality
+ * @brief Test function used to test the job_queue functionality.
  * 
  * Tests are performed using different threads to test the multi-threaded
  * features of the job_queue_t.
  *
- * @param tester associated tester object
+ * @param tester 	associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_job_queue(tester_t *tester);
 

Source/charon/testcases/linked_list_test.c

@@ -1,7 +1,7 @@
 /**
  * @file linked_list_test.c
  * 
- * @brief Tests to test the Linked List type linked_list_t
+ * @brief Tests for the linked_list_t class.
  * 
  */
 

Source/charon/testcases/linked_list_test.h

@@ -1,7 +1,7 @@
 /**
  * @file linked_list_test.h
  * 
- * @brief Tests to test the Linked List type linked_list_t
+ * @brief Tests for the linked_list_t class.
  * 
  */
 
@@ -26,7 +26,7 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function for the type linked_list_t
+ * @brief Test function for the type linked_list_t.
  *
  * Performs different kinds of assertions to check the functionality
  * of the linked_list_t in a Single-Threaded environment. 
@@ -34,12 +34,14 @@
  * @warning To be usable in multi-threaded software 
  * this list has to get protected with locks.
  *  
- * @param tester tester object
+ * @param tester 	tester object
+ * 
+ * @ingroup testcases
  */
 void test_linked_list(tester_t *tester);
 
 /**
- * @brief Test function for the type linked_list_t and its iterator
+ * @brief Test function for the type linked_list_t and its iterator.
  *
  * Performs different kinds of assertions to check the functionality
  * of the linked_list_t and its iterator in a Single-Threaded environment. 
@@ -47,13 +49,15 @@ void test_linked_list(tester_t *tester);
  * @warning To be usable in multi-threaded software 
  * this list has to get protected with locks.
  *  
- * @param tester tester object
+ * @param tester 	tester object
+ * 
+ * @ingroup testcases
  */
 void test_linked_list_iterator(tester_t *tester);
 
 /**
  * @brief Test function for the type linked_list_t and its insert and remove
- * 		  functions
+ * 		  functions.
  *
  * Performs different kinds of assertions to check the functionality
  * of the linked_list_t and its insert and remove functions
@@ -61,7 +65,9 @@ void test_linked_list_iterator(tester_t *tester);
  * @warning To be usable in multi-threaded software 
  * this list has to get protected with locks.
  *  
- * @param tester tester object
+ * @param tester 	tester object
+ * 
+ * @ingroup testcases
  */
 void test_linked_list_insert_and_remove(tester_t *tester);
 

Source/charon/testcases/packet_test.c

@@ -1,7 +1,7 @@
 /**
  * @file packet_test.c
  *
- * @brief Tests to test the class type packet_t
+ * @brief Tests for the packet_t class.
  *
  */
 

Source/charon/testcases/packet_test.h

@@ -1,7 +1,7 @@
 /**
  * @file packet_test.h
  *
- * @brief Tests to test the class type packet_t
+ * @brief Tests for the packet_t class.
  *
  */
 
@@ -26,10 +26,11 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function used to test the packet_t functionality
+ * @brief Test function used to test the packet_t functionality.
  *
- *
+ * @param tester 	associated tester_t object
- * @param tester associated tester_t object
+ * 
+ * @ingroup testcases
  */
 void test_packet(tester_t *tester);
 

Source/charon/testcases/parser_test.c

@@ -1,6 +1,7 @@
 /**
- * @file parser_test.h
+ * @file parser_test.c
  * 
+ * @brief Tests for the parser_t class.
  * 
  */
 

Source/charon/testcases/parser_test.h

@@ -1,6 +1,7 @@
 /**
  * @file parser_test.h
  * 
+ * @brief Tests for the parser_t class.
  * 
  */
 
@@ -24,15 +25,54 @@
 
 #include <utils/tester.h>
 
-
+/**
+ * @brief Test function used to test the parser_t functionality when 
+ * parsing a header payload.
+ *
+ * @param tester 	associated tester_t object
+ * 
+ * @ingroup testcases
+ */
 void test_parser_with_header_payload(tester_t *tester);
 
+/**
+ * @brief Test function used to test the parser_t functionality when 
+ * parsing a sa payload.
+ *
+ * @param tester 	associated tester_t object
+ * 
+ * @ingroup testcases
+ */
 void test_parser_with_sa_payload(tester_t *tester);
 
+/**
+ * @brief Test function used to test the parser_t functionality when 
+ * parsing a nonce payload.
+ *
+ * @param tester 	associated tester_t object
+ * 
+ * @ingroup testcases
+ */
 void test_parser_with_nonce_payload(tester_t *tester);
 
+/**
+ * @brief Test function used to test the parser_t functionality when 
+ * parsing a ke payload.
+ *
+ * @param tester 	associated tester_t object
+ * 
+ * @ingroup testcases
+ */
 void test_parser_with_ke_payload(tester_t *tester);
 
+/**
+ * @brief Test function used to test the parser_t functionality when 
+ * parsing a notify payload.
+ *
+ * @param tester 	associated tester_t object
+ * 
+ * @ingroup testcases
+ */
 void test_parser_with_notify_payload(tester_t *tester);
 
 #endif /*PARSER_TEST_H_*/

Source/charon/testcases/prf_plus_test.c

@@ -1,7 +1,7 @@
 /**
  * @file prf_plus_test.h
  * 
- * @brief Tests the prf_plus class 
+ * @brief Tests for the prf_plus_t class.
  * 
  */
 

Source/charon/testcases/prf_plus_test.h

@@ -1,7 +1,7 @@
 /**
  * @file prf_plus_test.h
  * 
- * @brief Tests the prf_plus class
+ * @brief Tests for the prf_plus_t class.
  * 
  */
 
@@ -29,7 +29,9 @@
 /**
  * @brief Test function used to test the prf_plus class.
  *
- * @param tester associated tester object
+ * @param tester 	associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_prf_plus(tester_t *tester);
 

Source/charon/testcases/receiver_test.c

@@ -1,7 +1,7 @@
 /**
  * @file receiver_test.c
  *
- * @brief Tests to test the Receiver (type receiver_t)
+ * @brief Tests for the receiver_t class.
  *
  */
 

Source/charon/testcases/receiver_test.h

@@ -1,7 +1,7 @@
 /**
  * @file receiver_test.h
  * 
- * @brief Tests to test the Receiver (type receiver_t)
+ * @brief Tests for the receiver_t class.
  * 
  */
 
@@ -26,9 +26,11 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function for the type receiver_t
+ * @brief Test function for the type receiver_t.
  * 
- * @param tester tester object
+ * @param tester 	tester object
+ * 
+ * @ingroup testcases
  */
 void test_receiver(tester_t *tester);
 

Source/charon/testcases/scheduler_test.c

@@ -1,7 +1,7 @@
 /**
  * @file scheduler_test.c
  * 
- * @brief Tests to test the Scheduler (type scheduler_t)
+ * @brief Tests for the scheduler_t class.
  * 
  */
 

Source/charon/testcases/scheduler_test.h

@@ -1,7 +1,7 @@
 /**
  * @file scheduler_test.h
  * 
- * @brief Tests to test the scheduler (type scheduler_t)
+ * @brief Tests for the scheduler_t class.
  * 
  */
 
@@ -26,9 +26,11 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function for the type scheduler_t
+ * @brief Test function for the type scheduler_t.
  * 
- * @param tester tester object
+ * @param tester		tester object
+ * 
+ * @ingroup testcases
  */
 void test_scheduler(tester_t *tester);
 

Source/charon/testcases/send_queue_test.c

@@ -1,7 +1,7 @@
 /**
  * @file send_queue_test.c
  *
- * @brief Tests to test the Send-Queue type send_queue_t
+ * @brief Tests for the send_queue_t class.
  *
  */
 

Source/charon/testcases/send_queue_test.h

@@ -1,7 +1,7 @@
 /**
  * @file send_queue_test.h
  * 
- * @brief Tests to test the Send-Queue type send_queue_t
+ * @brief Tests for the send_queue_t class.
  * 
  */
 
@@ -26,12 +26,14 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function used to test the send_queue functionality
+ * @brief Test function used to test the send_queue functionality.
  * 
  * Tests are performed using different threads to test the multi-threaded
  * features of the send_queue_t.
  *
- * @param tester associated tester object
+ * @param tester 	associated tester object
+ * 
+ * @ingroup testcases
  */
 void test_send_queue(tester_t *tester);
 

Source/charon/testcases/sender_test.c

@@ -1,7 +1,7 @@
 /**
  * @file sender_test.h
  *
- * @brief Tests to test the Sender (type sender_t)
+ * @brief Tests for the sender_t class.
  *
  */
 

Source/charon/testcases/sender_test.h

@@ -1,7 +1,7 @@
 /**
  * @file sender_test.h
  * 
- * @brief Tests to test the Sender (type sender_t)
+ * @brief Tests for the sender_t class.
  * 
  */
 
@@ -26,9 +26,11 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function for the type sender_t
+ * @brief Test function for the class sender_t.
  * 
- * @param tester tester object
+ * @param tester 	tester object
+ * 
+ * @ingroup testcases
  */
 void test_sender(tester_t *tester);
 

Source/charon/testcases/socket_test.c

@@ -1,7 +1,7 @@
 /**
- * @file thread_pool_test.c
+ * @file socket_test.c
  *
- * @brief Tests to test the Socket (type socket_t)
+ * @brief Tests for the socket_t class.
  *
  */
 

Source/charon/testcases/socket_test.h

@@ -1,7 +1,7 @@
 /**
  * @file socket_test.h
  * 
- * @brief Tests to test the Socket (type socket_t)
+ * @brief Tests for the socket_t class.
  * 
  */
 
@@ -26,9 +26,11 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function for the type socket_t
+ * @brief Test function for the class socket_t.
  * 
- * @param tester tester object
+ * @param tester 	tester object
+ * 
+ * @ingroup testcases
  */
 void test_socket(tester_t *tester);
 

Source/charon/testcases/testcases.c

@@ -1,7 +1,7 @@
 /**
  * @file tests.c
  * 
- * @brief Main for all tests
+ * @brief Main for all testcases.
  * 
  */
 

Source/charon/testcases/thread_pool_test.c

@@ -1,7 +1,7 @@
 /**
  * @file thread_pool_test.c
  * 
- * @brief Tests to test the Thread-Pool type thread_pool_t
+ * @brief Tests for the thread_pool_t class.
  * 
  */
 

Source/charon/testcases/thread_pool_test.h

@@ -1,7 +1,7 @@
 /**
  * @file thread_pool_test.h
  * 
- * @brief Tests to test the Thread-Pool type thread_pool_t
+ * @brief Tests for the thread_pool_t class.
  * 
  */
 
@@ -26,9 +26,11 @@
 #include <utils/tester.h>
 
 /**
- * @brief Test function for the type thread_pool_t
+ * @brief Test function for the class thread_pool_t.
  * 
- * @param tester tester object
+ * @param tester 	tester object
+ * 
+ * @ingroup testcases
  */
 void test_thread_pool(tester_t *tester);