- code documentation cleaned
authorJan Hutter <jhutter@hsr.ch>
Wed, 9 Nov 2005 17:20:05 +0000 (17:20 -0000)
committerJan Hutter <jhutter@hsr.ch>
Wed, 9 Nov 2005 17:20:05 +0000 (17:20 -0000)
Source/charon/configuration.c
Source/charon/configuration.h

index 244fe86..f44056d 100644 (file)
@@ -1,9 +1,11 @@
 /**
  * @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 */
 
 };
 
@@ -61,7 +63,7 @@ static status_t destroy (private_configuration_t *this)
 }
 
 /*
- * Described in Header-File
+ * described in header-file
  */
 configuration_t * configuration_create()
 {
@@ -71,7 +73,7 @@ configuration_t * configuration_create()
                return NULL;
        }
 
-       /* Public functions */
+       /* public functions */
        this->public.destroy = (status_t(*)(configuration_t*))destroy;
 
 
index f3b4833..006eb31 100644 (file)
@@ -1,8 +1,10 @@
 /**
  * @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
  * 
  */
 
@@ -35,19 +37,19 @@ 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 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_*/