diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2013-01-08 09:02:58 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2013-01-08 09:02:58 -0500 |
| commit | e354eb4f4fbd602adede59138c819eb94e7c1488 (patch) | |
| tree | 50a219aab9a9d69d1e53bf45f38ff15476dd0b0c /cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h | |
| parent | sapi: Doxygen Clean Up Task #1 (diff) | |
| download | rtems-e354eb4f4fbd602adede59138c819eb94e7c1488.tar.bz2 | |
libfs: Doxygen Clean Up Task #1
http://www.google-melange.com/gci/task/view/google/gci2012/8120204
Patch committed with fixes for whitespace issues.
Diffstat (limited to 'cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h')
| -rw-r--r-- | cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h b/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h index f7908d8716..46b2719a7e 100644 --- a/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h +++ b/cpukit/libfs/src/rfs/rtems-rfs-dir-hash.h @@ -26,9 +26,10 @@ /** * Compute a hash of the key over the length of string. * - * @param key The key to calculate the hash of. - * @param length The length of the key in bytes. - * @return uint32_t The hash. + * @param[in] key is a pointer to the key to calculate the hash of. + * @param[in] length is the length of the key in bytes. + * + * @retval hash The computed uint32_t hash. */ uint32_t rtems_rfs_dir_hash (const void *key, size_t length); |