added more API documentation to backends/interfaces

src/charon/config/backend_manager.h

@@ -34,12 +34,16 @@ typedef struct backend_manager_t backend_manager_t;
 
 
 /**
- * @brief A multiplexer to use multiple backends.
+ * @brief A loader and multiplexer to use multiple backends.
  *
- * Charon allows the use of multiple backend_manager backends simultaneously. To
+ * Charon allows the use of multiple configuration backends simultaneously. To
  * access all this backends by a single call, this class wraps multiple
- * backends behind a single object.
- * Backends may be registered and unregister at runtime dynamically.
+ * backends behind a single object. It is also responsible for loading
+ * the backend modules and cleaning them up.
+ * A backend may be writeable or not. All backends implement the backend_t
+ * interface, those who are writeable additionally implement the
+ * writeable_backend_t interface. Adding configs to the backend_manager will
+ * be redirected to the first writeable backend.
  * @verbatim
 
    +---------+      +-----------+         +--------------+     |
@@ -106,7 +110,7 @@ struct backend_manager_t {
 };
 
 /**
- * @brief Create a new instance of the manager and loads all backends.
+ * @brief Creates a new instance of the manager and loads all backends.
  *
  * @return		backend_manager instance
  *

src/charon/config/backends/backend.h

@@ -33,12 +33,12 @@ typedef struct backend_t backend_t;
 /**
  * @brief The interface for a configuration backend.
  *
- * A configuration backend is registered in the cfg_store. It does the actual
- * configuration lookup for the method it implements. See cfg_store_t for
+ * A configuration backend is loaded by the backend_manager. It does the actual
+ * configuration lookup for the method it implements. See backend_manager_t for
  * more information.
  *
  * @b Constructors:
- * - none, use implementations of backend_t.
+ * - implementations constructors
  * 
  * @ingroup backends
  */

src/charon/config/backends/local_backend.h

@@ -29,7 +29,7 @@ typedef struct local_backend_t local_backend_t;
 #include <config/backends/writeable_backend.h>
 
 /**
- * @brief An in-memory backend to store configuration information.
+ * @brief An in-memory backend to store configurations.
  *
  * The local_backend_t stores the configuration in a simple list. It
  * implements both, backend_t and writeable_backend_t.
@@ -50,7 +50,7 @@ struct local_backend_t {
 /**
  * @brief Create a backend_t instance implemented as local backend.
  *
- * @return backend instance.
+ * @return backend instance
  * 
  * @ingroup backends
  */

src/charon/config/backends/writeable_backend.h

@@ -29,7 +29,7 @@ typedef struct writeable_backend_t writeable_backend_t;
 #include <config/backends/backend.h>
 
 /**
- * @brief A writeable backend extends the backend by modification functions.
+ * @brief A writeable backend extends backend_t by modification functions.
  *
  * @b Constructors:
  *  - writeable_backend_create()