diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-09 12:01:44 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-09 12:01:44 +0300 |
commit | 9e365069afe156f33fadfad9705e1325f894cd54 (patch) | |
tree | 78373044d029feb51f987b45208e0c1a36958625 /source/blender/blenlib/BLI_hash_md5.h | |
parent | d8b42751625c915113b64f5a2d9c72f19f009fee (diff) |
Cleanup: move public doc-strings into headers for 'blenlib'
- Added space below non doc-string comments to make it clear
these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
- Minor improvements to doc-strings.
Ref T92709
Diffstat (limited to 'source/blender/blenlib/BLI_hash_md5.h')
-rw-r--r-- | source/blender/blenlib/BLI_hash_md5.h | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/source/blender/blenlib/BLI_hash_md5.h b/source/blender/blenlib/BLI_hash_md5.h index 227cfcc8876..7b5868d7ffc 100644 --- a/source/blender/blenlib/BLI_hash_md5.h +++ b/source/blender/blenlib/BLI_hash_md5.h @@ -24,17 +24,18 @@ extern "C" { #endif -/* Compute MD5 message digest for LEN bytes beginning at BUFFER. The - * result is always in little endian byte order, so that a byte-wise - * output yields to the wanted ASCII representation of the message - * digest. */ - +/** + * Compute MD5 message digest for 'len' bytes beginning at 'buffer'. + * The result is always in little endian byte order, + * so that a byte-wise output yields to the wanted ASCII representation of the message digest. + */ void *BLI_hash_md5_buffer(const char *buffer, size_t len, void *resblock); -/* Compute MD5 message digest for bytes read from STREAM. The - * resulting message digest number will be written into the 16 bytes - * beginning at RESBLOCK. */ - +/** + * Compute MD5 message digest for bytes read from 'stream'. + * The resulting message digest number will be written into the 16 bytes beginning at 'resblock'. + * \return Non-zero if an error occurred. + */ int BLI_hash_md5_stream(FILE *stream, void *resblock); char *BLI_hash_md5_to_hexdigest(void *resblock, char r_hex_digest[33]); |