diff options
| author | Martin Pool <mbp@samba.org> | 2003-02-28 04:17:30 +0000 |
|---|---|---|
| committer | Martin Pool <mbp@samba.org> | 2003-02-28 04:17:30 +0000 |
| commit | 42d9ec28cd55dbcfda546c84fb842938aeda544d (patch) | |
| tree | 1322b919186f03e054819220ac8f359fea547368 /source/lib | |
| parent | 9dbc3dcfe0bccf1f76930ae86970b48ba5ed1e91 (diff) | |
| download | samba-42d9ec28cd55dbcfda546c84fb842938aeda544d.tar.gz samba-42d9ec28cd55dbcfda546c84fb842938aeda544d.tar.xz samba-42d9ec28cd55dbcfda546c84fb842938aeda544d.zip | |
Doxygen janitor: fix parameter names, grammar, tag names.
Diffstat (limited to 'source/lib')
| -rw-r--r-- | source/lib/gencache.c | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/source/lib/gencache.c b/source/lib/gencache.c index 7260e477b80..5c8ad1339b2 100644 --- a/source/lib/gencache.c +++ b/source/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) @@ -134,12 +134,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) @@ -189,10 +189,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) @@ -218,14 +218,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) |