summaryrefslogtreecommitdiff
path: root/source3
diff options
context:
space:
mode:
authorTim Potter <tpot@samba.org>2003-04-14 02:18:10 +0000
committerTim Potter <tpot@samba.org>2003-04-14 02:18:10 +0000
commit564cd8cc2d86093f686c555629476986cf317f03 (patch)
treecc13db0030363f2c983a9aa3ca6c10aa705af198 /source3
parentf40f42e550694e6c55f9775d179c9eb73e1f8f4a (diff)
downloadsamba-564cd8cc2d86093f686c555629476986cf317f03.tar.gz
samba-564cd8cc2d86093f686c555629476986cf317f03.tar.bz2
samba-564cd8cc2d86093f686c555629476986cf317f03.zip
Merge of doxygen updates from HEAD.
(This used to be commit 6d7baad38fbdf0921c1d5eb59004c65cfe110975)
Diffstat (limited to 'source3')
-rw-r--r--source3/lib/gencache.c28
1 files changed, 14 insertions, 14 deletions
diff --git a/source3/lib/gencache.c b/source3/lib/gencache.c
index baec0e3b37..40b4d1390d 100644
--- a/source3/lib/gencache.c
+++ b/source3/lib/gencache.c
@@ -94,12 +94,12 @@ BOOL gencache_shutdown(void)
* Set an entry in the cache file. If there's no such
* one, then add it.
*
- * @param key string that represents a key of this entry
+ * @param keystr string that represents a key of this entry
* @param value text representation value being cached
* @param timeout time when the value is expired
*
- * @return true when entry is successfuly stored or
- * false on the attempt's failure
+ * @retval true when entry is successfuly stored
+ * @retval false on failure
**/
BOOL gencache_set(const char *keystr, const char *value, time_t timeout)
@@ -137,12 +137,12 @@ BOOL gencache_set(const char *keystr, const char *value, time_t timeout)
/**
* Set existing entry to the cache file.
*
- * @param key string that represents a key of this entry
- * @param value text representation value being cached
+ * @param keystr string that represents a key of this entry
+ * @param valstr text representation value being cached
* @param timeout time when the value is expired
*
- * @return true when entry is successfuly set or
- * false on the attempt's failure
+ * @retval true when entry is successfuly set
+ * @retval false on failure
**/
BOOL gencache_set_only(const char *keystr, const char *valstr, time_t timeout)
@@ -192,10 +192,10 @@ BOOL gencache_set_only(const char *keystr, const char *valstr, time_t timeout)
/**
* Delete one entry from the cache file.
*
- * @param key string that represents a key of this entry
+ * @param keystr string that represents a key of this entry
*
- * @return true upon successful deletion or
- * false in case of failure
+ * @retval true upon successful deletion
+ * @retval false in case of failure
**/
BOOL gencache_del(const char *keystr)
@@ -221,14 +221,14 @@ BOOL gencache_del(const char *keystr)
/**
* Get existing entry from the cache file.
*
- * @param key string that represents a key of this entry
- * @param value buffer that is allocated and filled with the entry value
+ * @param keystr string that represents a key of this entry
+ * @param valstr buffer that is allocated and filled with the entry value
* buffer's disposing must be done outside
* @param timeout pointer to a time_t that is filled with entry's
* timeout
*
- * @return true when entry is successfuly fetched or
- * false on the failure
+ * @retval true when entry is successfuly fetched
+ * @retval False for failure
**/
BOOL gencache_get(const char *keystr, char **valstr, time_t *timeout)