objects in source documentation renamed from xy-object to xy object

Source/charon/event_queue.h

@@ -62,7 +62,7 @@ struct event_queue_s {
 	 * @brief Adds a event to the queue, using a relative time.
 	 *
 	 * This function is non blocking and adds a job_t at a specific time to the list.
-	 * The specific job-object has to get destroyed by the thread which 
+	 * The specific job object has to get destroyed by the thread which
 	 * removes the job.
 	 *
 	 * @param event_queue 	calling object
@@ -78,7 +78,7 @@ struct event_queue_s {
 	 * @brief Adds a event to the queue, using an absolute time.
 	 *
 	 * This function is non blocking and adds a job_t at a specific time to the list.
-	 * The specific job-object has to get destroyed by the thread which 
+	 * The specific job object has to get destroyed by the thread which
 	 * removes the job.
 	 *
 	 * @param event_queue 	calling object

Source/charon/generator.c

@@ -163,7 +163,7 @@ static status_t generator_infos_destroy (generator_infos_t *this)
 }
 
 /**
- * Creates a generator_infos_t-object holding necessary informations 
+ * Creates a generator_infos_t object holding necessary informations
  * for generating (buffer, data_struct, etc)
  *
  * @param data_struct where to read the data out
@@ -219,7 +219,7 @@ struct private_generator_s {
 	 *
 	 * items are bytewhise written
 	 *
-	 * @param this private_generator_t-object
+	 * @param this private_generator_t object
 	 * @param data_struct data_struct to read data from
 	 * @param encoding_rules pointer to first encoding_rule of encoding rules array
 	 * @param encoding_rules_count number of encoding rules in encoding rules array

Source/charon/generator.h

@@ -38,7 +38,7 @@
 #define GENERATOR_DATA_BUFFER_INCREASE_VALUE 1000
 
 /**
- * @brief A generator_t-object which generates payloads of specific type
+ * @brief A generator_t object which generates payloads of specific type
  */
 typedef struct generator_s generator_t;
 

Source/charon/ike_sa.c

@@ -2,7 +2,7 @@
  * @file ike_sa.c
  *
  * @brief Class ike_sa_t. An object of this type is managed by an
- * ike_sa_manager_t-object and represents an IKE_SA
+ * ike_sa_manager_t object and represents an IKE_SA
  *
  */
 

Source/charon/ike_sa.h

@@ -2,7 +2,7 @@
  * @file ike_sa.h
  *
  * @brief Class ike_sa_t. An object of this type is managed by an
- * ike_sa_manager_t-object and represents an IKE_SA
+ * ike_sa_manager_t object and represents an IKE_SA
  *
  */
 
@@ -40,8 +40,8 @@ struct ike_sa_s {
 	/**
 	 * @brief Processes a incoming IKEv2-Message of type message_t
 	 *
-	 * @param this ike_sa_t-object object
- 	 * @param[in] message message_t-object to process
+	 * @param this ike_sa_t object object
+ 	 * @param[in] message message_t object to process
 	 * @return SUCCESSFUL if succeeded, FAILED otherwise
 	 */
 	status_t (*process_message) (ike_sa_t *this,message_t *message);
@@ -52,7 +52,7 @@ struct ike_sa_s {
 	 * This function is called when a new IKE_SA is created
 	 *
 	 * @param this ike_sa_t-message_t object object
- 	 * @param[in] message message_t-object to process
+ 	 * @param[in] message message_t object to process
 	 * @return SUCCESSFUL if succeeded, FAILED otherwise
 	 */
 	status_t (*process_configuration) (ike_sa_t *this,configuration_t *configuration);
@@ -75,13 +75,13 @@ struct ike_sa_s {
 };
 
 /**
- * Creates an ike_sa_t-object with a specific ike_sa_id_t-object
+ * Creates an ike_sa_t object with a specific ike_sa_id_t object
  *
- * @param[in] ike_sa_id ike_sa_id_t-object to associate with new IKE_SA.
+ * @param[in] ike_sa_id ike_sa_id_t object to associate with new IKE_SA.
  *  			 			The object is internal getting cloned
  * 			  			and so has to be destroyed by the caller.
  *
- * @warning the Content of internal ike_sa_id_t-Object can change over time 
+ * @warning the Content of internal ike_sa_id_t object can change over time
  * 			e.g. when a IKE_SA_INIT has been finished
  *
  * @return created ike_sa_t object

Source/charon/ike_sa_id.h

@@ -42,7 +42,7 @@ struct ike_sa_id_s {
 	 *
 	 * This function is called when a request or reply of a IKE_SA_INIT is received.
 	 *
-	 * @param this ike_sa_id_t-object
+	 * @param this ike_sa_id_t object
 	 * @param responder_spi SPI of responder to set
 	 * @return SUCCESSFUL if succeeded, FAILED otherwise
 	 */
@@ -52,7 +52,7 @@ struct ike_sa_id_s {
 	 * @brief Sets the SPI of the initiator.
 	 *
 	 *
-	 * @param this ike_sa_id_t-object
+	 * @param this ike_sa_id_t object
 	 * @param initiator_spi SPI to set
 	 * @return SUCCESSFUL if succeeded, FAILED otherwise
 	 */
@@ -61,7 +61,7 @@ struct ike_sa_id_s {
 	/**
 	 * @brief Returns TRUE if the initiator spi is set (not zero)
 	 *
-	 * @param this ike_sa_id_t-object
+	 * @param this ike_sa_id_t object
 	 * @return TRUE if the initiator spi is set, FALSE otherwise
 	 */
 	bool (*initiator_spi_is_set) (ike_sa_id_t *this);
@@ -69,7 +69,7 @@ struct ike_sa_id_s {
 	/**
 	 * @brief Returns TRUE if the responder spi is set (not zero)
 	 *
-	 * @param this ike_sa_id_t-object
+	 * @param this ike_sa_id_t object
 	 * @return TRUE if the responder spi is set, FALSE otherwise
 	 */
 	bool (*responder_spi_is_set) (ike_sa_id_t *this);
@@ -77,7 +77,7 @@ struct ike_sa_id_s {
 	/**
 	 * @brief Check if two ike_sa_ids are equal
 	 *
-	 * @param this ike_sa_id_t-object
+	 * @param this ike_sa_id_t object
  	 * @param other ike_sa_id object to check if equal
  	 * @param are_equal is set to TRUE, if given ike_sa_ids are equal, FALSE otherwise
 	 * @return SUCCESSFUL if succeeded, FAILED otherwise
@@ -85,10 +85,10 @@ struct ike_sa_id_s {
 	status_t (*equals) (ike_sa_id_t *this,ike_sa_id_t *other, bool *are_equal);
 
 	/**
-	 * @brief Replace the values of a given ike_sa_id_t-object with values 
-	 * from another ike_sa_id_t-Object
+	 * @brief Replace the values of a given ike_sa_id_t object with values
+	 * from another ike_sa_id_t object
 	 *
-	 * @param this ike_sa_id_t-object
+	 * @param this ike_sa_id_t object
  	 * @param other ike_sa_id_t object which values will be taken
 	 * @return SUCCESSFUL if succeeded, FAILED otherwise
 	 */
@@ -97,7 +97,7 @@ struct ike_sa_id_s {
 	/**
 	 * @brief get spis and role of an ike_sa_id
 	 *
-	 * @param this ike_sa_id_t-object
+	 * @param this ike_sa_id_t object
  	 * @param initiator address to write initator spi
  	 * @param responder address to write responder spi
  	 * @param role address to write role
@@ -106,10 +106,10 @@ struct ike_sa_id_s {
 	status_t (*get_values) (ike_sa_id_t *this, spi_t *initiator, spi_t *responder, ike_sa_role_t *role);
 
 	/**
-	 * @brief Clones a given ike_sa_id_t-object
+	 * @brief Clones a given ike_sa_id_t object
 	 *
-	 * @param this ike_sa_id_t-object
- 	 * @param clone_of_this ike_sa_id_t-object which will be created
+	 * @param this ike_sa_id_t object
+ 	 * @param clone_of_this ike_sa_id_t object which will be created
 	 * @return SUCCESSFUL if succeeded, FAILED otherwise
 	 */
 	status_t (*clone) (ike_sa_id_t *this,ike_sa_id_t **clone_of_this);
@@ -117,16 +117,16 @@ struct ike_sa_id_s {
 	/**
 	 * @brief Destroys a ike_sa_id_tobject
 	 *
-	 * @param this ike_sa_id_t-object
+	 * @param this ike_sa_id_t object
 	 * @return SUCCESSFUL if succeeded, FAILED otherwise
 	 */
 	status_t (*destroy) (ike_sa_id_t *this);
 };
 
 /**
- * Creates an ike_sa_id_t-object with specific spi's and defined role
+ * Creates an ike_sa_id_t object with specific spi's and defined role
  *
- * @warning The initiator SPI and role is not changeable after initiating a ike_sa_id-object 
+ * @warning The initiator SPI and role is not changeable after initiating a ike_sa_id object
  */
 ike_sa_id_t * ike_sa_id_create(spi_t initiator_spi, spi_t responder_spi,ike_sa_role_t role);
 

Source/charon/job_queue.h

@@ -61,7 +61,7 @@ struct job_queue_s {
 	 * @brief adds a job to the queue
 	 *
 	 * This function is non blocking and adds a job_t to the list.
-	 * The specific job-object has to get destroyed by the thread which 
+	 * The specific job object has to get destroyed by the thread which
 	 * removes the job.
 	 *
 	 * @param job_queue_t calling object

Source/charon/logger.h

@@ -60,7 +60,7 @@ struct logger_s {
 	 * The specefied loglevels must ALL be activated that
 	 * the log is done.
 	 *
-	 * @param this 		logger_t-object
+	 * @param this 		logger_t object
 	 * @param loglevel 	or'ed set of loglevels
 	 * @param format 	printf like format string
 	 * @param ... 		printf like parameters
@@ -75,7 +75,7 @@ struct logger_s {
 	 * The specefied loglevels must ALL be activated that
 	 * the log is done.
 	 *
-	 * @param this 		logger_t-object
+	 * @param this 		logger_t object
 	 * @param loglevel 	or'ed set of loglevels
 	 * @param label 	a labeling name, logged with the bytes
 	 * @param bytes 	pointer to the bytes to dump
@@ -91,7 +91,7 @@ struct logger_s {
 	 * The specefied loglevels must ALL be activated that
 	 * the log is done.
 	 *
-	 * @param this 		logger_t-object
+	 * @param this 		logger_t object
 	 * @param loglevel 	or'ed set of loglevels
 	 * @param label 	a labeling name, logged with the bytes
 	 * @param chunk		pointer to a chunk to log
@@ -101,9 +101,9 @@ struct logger_s {
 	status_t (*log_chunk) (logger_t *this, logger_level_t loglevel, char *label, chunk_t *chunk);
 
 	/**
-	 * @brief Enables a loglevel for the current logger_t-object.
+	 * @brief Enables a loglevel for the current logger_t object.
 	 *
-	 * @param 			this logger_t-object
+	 * @param 			this logger_t object
 	 * @param 			log_level loglevel to enable
 	 * @return
 	 * 					- SUCCESS in any case
@@ -111,9 +111,9 @@ struct logger_s {
 	status_t (*enable_level) (logger_t *this, logger_level_t log_level);
 
 	/**
-	 * @brief Disables a loglevel for the current logger_t-object.
+	 * @brief Disables a loglevel for the current logger_t object.
 	 *
-	 * @param 			this logger_t-object
+	 * @param 			this logger_t object
 	 * @param 			log_level loglevel to enable
 	 * @return
 	 * 					- SUCCESS in any case
@@ -131,11 +131,11 @@ struct logger_s {
 };
 
 /**
- * @brief Constructor to create a logger_t-object.
+ * @brief Constructor to create a logger_t object.
  *
- * @param logger_name 	Name for the logger_t-object
- * @param log_level		or'ed set of log_levels to assign to the new logger_t-object
- * @return 				logger_t-object or NULL if failed
+ * @param logger_name 	Name for the logger_t object
+ * @param log_level		or'ed set of log_levels to assign to the new logger_t object
+ * @return 				logger_t object or NULL if failed
  */
 logger_t *logger_create(char *logger_name, logger_level_t log_level);
 

Source/charon/message.h

@@ -44,7 +44,7 @@ struct message_s {
 };
 
 /**
- * Creates an message_t-object
+ * Creates an message_t object
  *
  * @return created message_t object
  */

Source/charon/parser.h

@@ -29,7 +29,7 @@
 
 
 /**
- * @brief A parser_t-object which parses payloads of specific type
+ * @brief A parser_t object which parses payloads of specific type
  */
 typedef struct parser_s parser_t;
 

Source/charon/receiver.c

@@ -1,7 +1,7 @@
 /**
  * @file receiver.c
  *
- * @brief Implements the Receiver Thread encapsulated in the receiver_t-object
+ * @brief Implements the Receiver Thread encapsulated in the receiver_t object
  *
  */
 
@@ -43,7 +43,7 @@ struct private_receiver_s {
 	 receiver_t public;
 
 	 /**
-	  * Assigned thread to the receiver_t-object
+	  * Assigned thread to the receiver_t object
 	  */
 	 pthread_t assigned_thread;
 

Source/charon/receiver.h

@@ -1,7 +1,7 @@
 /**
  * @file receiver.h
  *
- * @brief Implements the Receiver Thread encapsulated in the receiver_t-object
+ * @brief Implements the Receiver Thread encapsulated in the receiver_t object
  *
  */
 

Source/charon/scheduler.c

@@ -40,7 +40,7 @@ struct private_scheduler_s {
 	 scheduler_t public;
 
 	 /**
-	  * Assigned thread to the scheduler_t-object
+	  * Assigned thread to the scheduler_t object
 	  */
 	 pthread_t assigned_thread;
 

Source/charon/send_queue.h

@@ -62,7 +62,7 @@ struct send_queue_s {
 	 * @brief adds a packet to the queue
 	 *
 	 * This function is non blocking and adds a packet_t to the list.
-	 * The specific packet-object has to get destroyed by the thread which 
+	 * The specific packet object has to get destroyed by the thread which
 	 * removes the packet.
 	 *
 	 * @param send_queue_t calling object

Source/charon/sender.c

@@ -1,7 +1,7 @@
 /**
  * @file sender.c
  *
- * @brief Implements the Sender Thread encapsulated in the sender_t-object
+ * @brief Implements the Sender Thread encapsulated in the sender_t object
  *
  */
 
@@ -42,7 +42,7 @@ struct private_sender_s {
 	 sender_t public;
 
 	 /**
-	  * Assigned thread to the sender_t-object
+	  * Assigned thread to the sender_t object
 	  */
 	 pthread_t assigned_thread;
 

Source/charon/sender.h

@@ -1,7 +1,7 @@
 /**
  * @file sender.h
  *
- * @brief Implements the Sender Thread encapsulated in the sender_t-object
+ * @brief Implements the Sender Thread encapsulated in the sender_t object
  *
  */
 

Source/charon/tester.h

@@ -59,7 +59,7 @@ struct tester_s {
 	 * @brief run a specific test case
 	 *
 	 * @param this tester object
-	 * @param test pointer to a test_t-object which will be performed
+	 * @param test pointer to a test_t object which will be performed
 	 * @param Name of the Test
 	 */
  	status_t (*perform_test) (tester_t *tester, test_t *test);

Source/charon/tests/ike_sa_manager_test.h

@@ -29,7 +29,7 @@
  * @brief Test function used to test the ike_sa_manager_t functionality
  *
  *
- * @param tester associated tester_t-object
+ * @param tester associated tester_t object
  */
 void test_ike_sa_manager(tester_t *tester);
 

Source/charon/tests/ike_sa_test.h

@@ -29,7 +29,7 @@
  * @brief Test function used to test the ike_sa_t functionality
  *
  *
- * @param tester associated tester_t-object
+ * @param tester associated tester_t object
  */
 void test_ike_sa(tester_t *tester);
 

Source/charon/tests/send_queue_test.c

@@ -36,7 +36,7 @@ typedef struct send_queue_test_s send_queue_test_t;
 
 struct send_queue_test_s{
 	/**
-	 * Associated tester_t-Object
+	 * Associated tester_t object
 	 */
 	tester_t *tester;