/**
* @file configuration.c
- *
- * @brief Class configuration_t.
- * Object of this type represents a configuration for an IKE_SA
- *
+ *
+ * @brief class configuration_t.
+ *
+ *
+ * Object of this type represents a configuration for an IKE_SA and its child_sa's
+ *
*/
/*
#include "configuration.h"
/**
- * Private data of an configuration_t object
+ * private data of an configuration_t object
*/
typedef struct private_configuration_s private_configuration_t;
struct private_configuration_s {
/**
- * Public part of a configuration_t object
+ * public part of a configuration_t object
*/
configuration_t public;
- /* Private values */
+ /* private values */
};
}
/*
- * Described in Header-File
+ * described in header-file
*/
configuration_t * configuration_create()
{
return NULL;
}
- /* Public functions */
+ /* public functions */
this->public.destroy = (status_t(*)(configuration_t*))destroy;
/**
* @file configuration.h
*
- * @brief Class configuration_t.
- * Object of this type represents a configuration for an IKE_SA
+ * @brief class configuration_t.
+ *
+ *
+ * Object of this type represents a configuration for an IKE_SA and its child_sa's
*
*/
struct configuration_s {
/**
- * @brief Destroys a configuration_t object
+ * @brief destroys a configuration_t object
*
* @param this configuration_t object
- * @return SUCCESSFUL if succeeded, FAILED otherwise
+ * @return SUCCESS if succeeded, FAILED when NULL pointer given
*/
status_t (*destroy) (configuration_t *this);
};
/**
- * Creates an configuration_t-object
+ * creates an configuration_t object
*
* @return created configuration_t object
*/
-configuration_t * configuration_create();
+configuration_t *configuration_create();
#endif /*CONFIGURATION_H_*/