- source code fully documented
This commit is contained in:
parent
1dab9d0273
commit
11975d5451
2 changed files with 19 additions and 17 deletions
|
@ -1,10 +1,9 @@
|
|||
/**
|
||||
* @file configuration.c
|
||||
*
|
||||
* @brief class configuration_t.
|
||||
* @brief Configuration class used to store IKE_SA-configurations.
|
||||
*
|
||||
*
|
||||
* Object of this type represents a configuration for an IKE_SA and its child_sa's
|
||||
* Object of this type represents a configuration for an IKE_SA and its child_sa's.
|
||||
*
|
||||
*/
|
||||
|
||||
|
@ -33,24 +32,24 @@
|
|||
#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 */
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief implements function destroy of configuration_t
|
||||
* Implements function destroy of configuration_t.
|
||||
* See #configuration_s.destroy for description.
|
||||
*/
|
||||
static status_t destroy (private_configuration_t *this)
|
||||
{
|
||||
|
@ -63,7 +62,7 @@ static status_t destroy (private_configuration_t *this)
|
|||
}
|
||||
|
||||
/*
|
||||
* described in header-file
|
||||
* Described in header-file
|
||||
*/
|
||||
configuration_t * configuration_create()
|
||||
{
|
||||
|
|
|
@ -1,10 +1,9 @@
|
|||
/**
|
||||
* @file configuration.h
|
||||
*
|
||||
* @brief class configuration_t.
|
||||
* @brief Configuration class used to store IKE_SA-configurations.
|
||||
*
|
||||
*
|
||||
* Object of this type represents a configuration for an IKE_SA and its child_sa's
|
||||
* Object of this type represents a configuration for an IKE_SA and its child_sa's.
|
||||
*
|
||||
*/
|
||||
|
||||
|
@ -37,18 +36,22 @@ typedef struct configuration_s configuration_t;
|
|||
struct configuration_s {
|
||||
|
||||
/**
|
||||
* @brief destroys a configuration_t object
|
||||
* @brief Destroys a configuration_t object
|
||||
*
|
||||
* @param this configuration_t object
|
||||
* @return SUCCESS if succeeded, FAILED when NULL pointer given
|
||||
* @param this configuration_t object
|
||||
* @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
|
||||
* @return
|
||||
* - pointer to created configuration_t object if succeeded
|
||||
* - NULL if memory allocation failed
|
||||
*/
|
||||
configuration_t *configuration_create();
|
||||
|
||||
|
|
Loading…
Reference in a new issue