]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
Doxygen
authorArran Cudbard-Bell <a.cudbardb@freeradius.org>
Sun, 21 Apr 2019 18:59:25 +0000 (14:59 -0400)
committerArran Cudbard-Bell <a.cudbardb@freeradius.org>
Sun, 21 Apr 2019 18:59:25 +0000 (14:59 -0400)
src/modules/rlm_cache/drivers/rlm_cache_memcached/rlm_cache_memcached.c
src/modules/rlm_cache/drivers/rlm_cache_rbtree/rlm_cache_rbtree.c
src/modules/rlm_cache/drivers/rlm_cache_redis/rlm_cache_redis.c
src/modules/rlm_cache/rlm_cache.h

index cb8693b50fff6f95c419086f43c858e16551316c..fc82ed15eb84c5cc2ae535f90cc119e8a991a4fa 100644 (file)
@@ -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)
 {
index 8cf6841e2a7618d261519861f172a8f512f11d68..903e6c1fcc570ea45eda91ce89da4c93b7e81fcb 100644 (file)
@@ -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)
 {
index 3530a8396c29d820f2c65730869ada4598968a35..fd7fa3475ff6ffb5bd09621ad9800f4c5b138ed0 100644 (file)
@@ -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)
 {
index 13c4e7c1fecb1e996a56b380ba9f6d5d396196dc..bf188b934bc5f387e2e4367faebc9997ddbba875 100644 (file)
@@ -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
  *
  */