comparison sha.h @ 957:e34e8d654ded libavutil

Fix grammar errors in documentation
author mru
date Wed, 30 Jun 2010 15:38:06 +0000
parents 848401bb3478
children
comparison
equal deleted inserted replaced
956:2894d4c208dc 957:e34e8d654ded
26 extern const int av_sha_size; 26 extern const int av_sha_size;
27 27
28 struct AVSHA; 28 struct AVSHA;
29 29
30 /** 30 /**
31 * Initializes SHA-1 or SHA-2 hashing. 31 * Initialize SHA-1 or SHA-2 hashing.
32 * 32 *
33 * @param context pointer to the function context (of size av_sha_size) 33 * @param context pointer to the function context (of size av_sha_size)
34 * @param bits number of bits in digest (SHA-1 - 160 bits, SHA-2 224 or 256 bits) 34 * @param bits number of bits in digest (SHA-1 - 160 bits, SHA-2 224 or 256 bits)
35 * @return zero if initialization succeeded, -1 otherwise 35 * @return zero if initialization succeeded, -1 otherwise
36 */ 36 */
37 int av_sha_init(struct AVSHA* context, int bits); 37 int av_sha_init(struct AVSHA* context, int bits);
38 38
39 /** 39 /**
40 * Updates hash value. 40 * Update hash value.
41 * 41 *
42 * @param context hash function context 42 * @param context hash function context
43 * @param data input data to update hash with 43 * @param data input data to update hash with
44 * @param len input data length 44 * @param len input data length
45 */ 45 */
46 void av_sha_update(struct AVSHA* context, const uint8_t* data, unsigned int len); 46 void av_sha_update(struct AVSHA* context, const uint8_t* data, unsigned int len);
47 47
48 /** 48 /**
49 * Finishes hashing and output digest value. 49 * Finish hashing and output digest value.
50 * 50 *
51 * @param context hash function context 51 * @param context hash function context
52 * @param digest buffer where output digest value is stored 52 * @param digest buffer where output digest value is stored
53 */ 53 */
54 void av_sha_final(struct AVSHA* context, uint8_t *digest); 54 void av_sha_final(struct AVSHA* context, uint8_t *digest);