Doxygen

FreeRADIUS · Apr 21, 2019 · c59b0ee · c59b0ee
1 parent 8d57357
commit c59b0ee
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 18 deletions.
diff --git a/src/modules/rlm_cache/drivers/rlm_cache_memcached/rlm_cache_memcached.c b/src/modules/rlm_cache/drivers/rlm_cache_memcached/rlm_cache_memcached.c
@@ -99,7 +99,13 @@ static void *mod_conn_create(TALLOC_CTX *ctx, void *instance, struct timeval con
 
 /** Create a new rlm_cache_memcached instance
  *
- * @copydetails cache_instantiate_t
+ * @param instance	A uint8_t array of inst_size if inst_size > 0, else NULL,
+ *			this should contain the result of parsing the driver's
+ *			CONF_PARSER array that it specified in the interface struct.
+ * @param conf		section holding driver specific #CONF_PAIR (s).
+ * @return
+ *	- 0 on success.
+ *	- -1 on failure.
  */
 static int mod_instantiate(void *instance, CONF_SECTION *conf)
 {

diff --git a/src/modules/rlm_cache/drivers/rlm_cache_rbtree/rlm_cache_rbtree.c b/src/modules/rlm_cache/drivers/rlm_cache_rbtree/rlm_cache_rbtree.c
@@ -98,7 +98,13 @@ static int mod_detach(void *instance)
 
 /** Create a new cache_rbtree instance
  *
- * @copydetails cache_instantiate_t
+ * @param instance	A uint8_t array of inst_size if inst_size > 0, else NULL,
+ *			this should contain the result of parsing the driver's
+ *			CONF_PARSER array that it specified in the interface struct.
+ * @param conf		section holding driver specific #CONF_PAIR (s).
+ * @return
+ *	- 0 on success.
+ *	- -1 on failure.
  */
 static int mod_instantiate(void *instance, UNUSED CONF_SECTION *conf)
 {

diff --git a/src/modules/rlm_cache/drivers/rlm_cache_redis/rlm_cache_redis.c b/src/modules/rlm_cache/drivers/rlm_cache_redis/rlm_cache_redis.c
@@ -64,7 +64,13 @@ fr_dict_attr_autoload_t rlm_cache_redis_dict_attr[] = {
 
 /** Create a new rlm_cache_redis instance
  *
- * @copydetails cache_instantiate_t
+ * @param instance	A uint8_t array of inst_size if inst_size > 0, else NULL,
+ *			this should contain the result of parsing the driver's
+ *			CONF_PARSER array that it specified in the interface struct.
+ * @param conf		section holding driver specific #CONF_PAIR (s).
+ * @return
+ *	- 0 on success.
+ *	- -1 on failure.
  */
 static int mod_instantiate(void *instance, CONF_SECTION *conf)
 {

diff --git a/src/modules/rlm_cache/rlm_cache.h b/src/modules/rlm_cache/rlm_cache.h
@@ -84,21 +84,6 @@ typedef struct {
 	vp_map_t		*maps;			//!< Head of the maps list.
 } rlm_cache_entry_t;
 
-/** Instantiate a driver
- *
- * Function to handle any driver specific instantiation.
- *
- * @param config	of the rlm_cache module.  Should not be modified.
- * @param instance	A uint8_t array of inst_size if inst_size > 0, else NULL,
- *			this should contain the result of parsing the driver's
- *			CONF_PARSER array that it specified in the interface struct.
- * @param conf		section holding driver specific #CONF_PAIR (s).
- * @return
- *	- 0 on success.
- *	- -1 on failure.
- */
-typedef int		(*cache_instantiate_t)(rlm_cache_config_t const *config, void *instance, CONF_SECTION *conf);
-
 /** Allocate a new cache entry
  *
  */