Mercurial > libavutil.hg
changeset 957:e34e8d654ded libavutil
Fix grammar errors in documentation
author | mru |
---|---|
date | Wed, 30 Jun 2010 15:38:06 +0000 |
parents | 2894d4c208dc |
children | f789d66969a4 |
files | aes.h avutil.h base64.h common.h crc.c error.h eval.h fifo.h integer.h internal.h lfg.h log.h mathematics.h mem.h pixdesc.h random_seed.h rational.h sha.h sha1.h tree.h |
diffstat | 20 files changed, 89 insertions(+), 89 deletions(-) [+] |
line wrap: on
line diff
--- a/aes.h Wed Jun 30 10:38:04 2010 +0000 +++ b/aes.h Wed Jun 30 15:38:06 2010 +0000 @@ -28,14 +28,14 @@ struct AVAES; /** - * Initializes an AVAES context. + * Initialize an AVAES context. * @param key_bits 128, 192 or 256 * @param decrypt 0 for encryption, 1 for decryption */ int av_aes_init(struct AVAES *a, const uint8_t *key, int key_bits, int decrypt); /** - * Encrypts / decrypts. + * Encrypt / decrypt. * @param count number of 16 byte blocks * @param dst destination array, can be equal to src * @param src source array, can be equal to dst
--- a/avutil.h Wed Jun 30 10:38:04 2010 +0000 +++ b/avutil.h Wed Jun 30 15:38:06 2010 +0000 @@ -54,17 +54,17 @@ #define LIBAVUTIL_IDENT "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION) /** - * Returns the LIBAVUTIL_VERSION_INT constant. + * Return the LIBAVUTIL_VERSION_INT constant. */ unsigned avutil_version(void); /** - * Returns the libavutil build-time configuration. + * Return the libavutil build-time configuration. */ const char *avutil_configuration(void); /** - * Returns the libavutil license. + * Return the libavutil license. */ const char *avutil_license(void);
--- a/base64.h Wed Jun 30 10:38:04 2010 +0000 +++ b/base64.h Wed Jun 30 15:38:06 2010 +0000 @@ -24,7 +24,7 @@ #include <stdint.h> /** - * Decodes the base64-encoded string in in and puts the decoded + * Decode the base64-encoded string in in and put the decoded * data in out. * * @param out_size size in bytes of the out buffer, it should be at @@ -35,7 +35,7 @@ int av_base64_decode(uint8_t *out, const char *in, int out_size); /** - * Encodes in base64 the data in in and puts the resulting string + * Encode in base64 the data in in and put the resulting string * in out. * * @param out_size size in bytes of the out string, it should be at
--- a/common.h Wed Jun 30 10:38:04 2010 +0000 +++ b/common.h Wed Jun 30 15:38:06 2010 +0000 @@ -98,7 +98,7 @@ #endif /** - * Clips a signed integer value into the amin-amax range. + * Clip a signed integer value into the amin-amax range. * @param a value to clip * @param amin minimum value of the clip range * @param amax maximum value of the clip range @@ -112,7 +112,7 @@ } /** - * Clips a signed integer value into the 0-255 range. + * Clip a signed integer value into the 0-255 range. * @param a value to clip * @return clipped value */ @@ -123,7 +123,7 @@ } /** - * Clips a signed integer value into the -128,127 range. + * Clip a signed integer value into the -128,127 range. * @param a value to clip * @return clipped value */ @@ -134,7 +134,7 @@ } /** - * Clips a signed integer value into the 0-65535 range. + * Clip a signed integer value into the 0-65535 range. * @param a value to clip * @return clipped value */ @@ -145,7 +145,7 @@ } /** - * Clips a signed integer value into the -32768,32767 range. + * Clip a signed integer value into the -32768,32767 range. * @param a value to clip * @return clipped value */ @@ -156,7 +156,7 @@ } /** - * Clips a signed 64-bit integer value into the -2147483648,2147483647 range. + * Clip a signed 64-bit integer value into the -2147483648,2147483647 range. * @param a value to clip * @return clipped value */ @@ -167,7 +167,7 @@ } /** - * Clips a float value into the amin-amax range. + * Clip a float value into the amin-amax range. * @param a value to clip * @param amin minimum value of the clip range * @param amax maximum value of the clip range @@ -180,7 +180,7 @@ else return a; } -/** Computes ceil(log2(x)). +/** Compute ceil(log2(x)). * @param x value used to compute ceil(log2(x)) * @return computed ceiling of log2(x) */ @@ -194,7 +194,7 @@ /*! * \def GET_UTF8(val, GET_BYTE, ERROR) - * Converts a UTF-8 character (up to 4 bytes long) to its 32-bit UCS-4 encoded form + * Convert a UTF-8 character (up to 4 bytes long) to its 32-bit UCS-4 encoded form * \param val is the output and should be of type uint32_t. It holds the converted * UCS-4 character and should be a left value. * \param GET_BYTE gets UTF-8 encoded bytes from any proper source. It can be @@ -222,7 +222,7 @@ /*! * \def GET_UTF16(val, GET_16BIT, ERROR) - * Converts a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form + * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form * \param val is the output and should be of type uint32_t. It holds the converted * UCS-4 character and should be a left value. * \param GET_16BIT gets two bytes of UTF-16 encoded data converted to native endianness. @@ -246,7 +246,7 @@ /*! * \def PUT_UTF8(val, tmp, PUT_BYTE) - * Converts a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long). + * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long). * \param val is an input-only argument and should be of type uint32_t. It holds * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If * val is given as a function it is executed only once. @@ -282,7 +282,7 @@ /*! * \def PUT_UTF16(val, tmp, PUT_16BIT) - * Converts a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes). + * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes). * \param val is an input-only argument and should be of type uint32_t. It holds * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If * val is given as a function it is executed only once.
--- a/crc.c Wed Jun 30 10:38:04 2010 +0000 +++ b/crc.c Wed Jun 30 15:38:06 2010 +0000 @@ -41,7 +41,7 @@ #endif /** - * Initializes a CRC table. + * Initialize a CRC table. * @param ctx must be an array of size sizeof(AVCRC)*257 or sizeof(AVCRC)*1024 * @param cts_size size of ctx in bytes * @param le If 1, the lowest bit represents the coefficient for the highest @@ -88,7 +88,7 @@ } /** - * Gets an initialized standard CRC table. + * Get an initialized standard CRC table. * @param crc_id ID of a standard CRC * @return a pointer to the CRC table or NULL on failure */ @@ -106,7 +106,7 @@ } /** - * Calculates the CRC of a block. + * Calculate the CRC of a block. * @param crc CRC of previous blocks if any or initial value for CRC * @return CRC updated with the data from the given block *
--- a/error.h Wed Jun 30 10:38:04 2010 +0000 +++ b/error.h Wed Jun 30 15:38:06 2010 +0000 @@ -58,7 +58,7 @@ #endif /** - * Puts a description of the AVERROR code errnum in errbuf. + * Put a description of the AVERROR code errnum in errbuf. * In case of failure the global variable errno is set to indicate the * error. Even in case of failure av_strerror() will print a generic * error message indicating the errnum provided to errbuf.
--- a/eval.h Wed Jun 30 10:38:04 2010 +0000 +++ b/eval.h Wed Jun 30 15:38:06 2010 +0000 @@ -29,7 +29,7 @@ typedef struct AVExpr AVExpr; /** - * Parses and evaluates an expression. + * Parse and evaluate an expression. * Note, this is significantly slower than av_eval_expr(). * * @param res a pointer to a double where is put the result value of @@ -53,7 +53,7 @@ void *opaque, int log_offset, void *log_ctx); /** - * Parses an expression. + * Parse an expression. * * @param expr a pointer where is put an AVExpr containing the parsed * value in case of successfull parsing, or NULL otherwise. @@ -76,7 +76,7 @@ int log_offset, void *log_ctx); /** - * Evaluates a previously parsed expression. + * Evaluate a previously parsed expression. * * @param const_values a zero terminated array of values for the identifiers from av_parse_expr() const_names * @param opaque a pointer which will be passed to all functions from funcs1 and funcs2 @@ -85,12 +85,12 @@ double av_eval_expr(AVExpr *e, const double *const_values, void *opaque); /** - * Frees a parsed expression previously created with av_parse_expr(). + * Free a parsed expression previously created with av_parse_expr(). */ void av_free_expr(AVExpr *e); /** - * Parses the string in numstr and returns its value as a double. If + * Parse the string in numstr and return its value as a double. If * the string is empty, contains only whitespaces, or does not contain * an initial substring that has the expected syntax for a * floating-point number, no conversion is performed. In this case,
--- a/fifo.h Wed Jun 30 10:38:04 2010 +0000 +++ b/fifo.h Wed Jun 30 15:38:06 2010 +0000 @@ -33,26 +33,26 @@ } AVFifoBuffer; /** - * Initializes an AVFifoBuffer. + * Initialize an AVFifoBuffer. * @param size of FIFO * @return AVFifoBuffer or NULL in case of memory allocation failure */ AVFifoBuffer *av_fifo_alloc(unsigned int size); /** - * Frees an AVFifoBuffer. + * Free an AVFifoBuffer. * @param *f AVFifoBuffer to free */ void av_fifo_free(AVFifoBuffer *f); /** - * Resets the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied. + * Reset the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied. * @param *f AVFifoBuffer to reset */ void av_fifo_reset(AVFifoBuffer *f); /** - * Returns the amount of data in bytes in the AVFifoBuffer, that is the + * Return the amount of data in bytes in the AVFifoBuffer, that is the * amount of data you can read from it. * @param *f AVFifoBuffer to read from * @return size @@ -60,7 +60,7 @@ int av_fifo_size(AVFifoBuffer *f); /** - * Returns the amount of space in bytes in the AVFifoBuffer, that is the + * Return the amount of space in bytes in the AVFifoBuffer, that is the * amount of data you can write into it. * @param *f AVFifoBuffer to write into * @return size @@ -68,7 +68,7 @@ int av_fifo_space(AVFifoBuffer *f); /** - * Feeds data from an AVFifoBuffer to a user-supplied callback. + * Feed data from an AVFifoBuffer to a user-supplied callback. * @param *f AVFifoBuffer to read from * @param buf_size number of bytes to read * @param *func generic read function @@ -77,7 +77,7 @@ int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int)); /** - * Feeds data from a user-supplied callback to an AVFifoBuffer. + * Feed data from a user-supplied callback to an AVFifoBuffer. * @param *f AVFifoBuffer to write to * @param *src data source; non-const since it may be used as a * modifiable context by the function defined in func @@ -92,7 +92,7 @@ int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int)); /** - * Resizes an AVFifoBuffer. + * Resize an AVFifoBuffer. * @param *f AVFifoBuffer to resize * @param size new AVFifoBuffer size in bytes * @return <0 for failure, >=0 otherwise @@ -100,7 +100,7 @@ int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size); /** - * Reads and discards the specified amount of data from an AVFifoBuffer. + * Read and discard the specified amount of data from an AVFifoBuffer. * @param *f AVFifoBuffer to read from * @param size amount of data to read in bytes */
--- a/integer.h Wed Jun 30 10:38:04 2010 +0000 +++ b/integer.h Wed Jun 30 15:38:06 2010 +0000 @@ -41,7 +41,7 @@ AVInteger av_sub_i(AVInteger a, AVInteger b) av_const; /** - * Returns the rounded-down value of the base 2 logarithm of the given + * Return the rounded-down value of the base 2 logarithm of the given * AVInteger. This is simply the index of the most significant bit * which is 1, or 0 if all bits are 0. */ @@ -49,7 +49,7 @@ AVInteger av_mul_i(AVInteger a, AVInteger b) av_const; /** - * Returns 0 if a==b, 1 if a>b and -1 if a<b. + * Return 0 if a==b, 1 if a>b and -1 if a<b. */ int av_cmp_i(AVInteger a, AVInteger b) av_const; @@ -61,23 +61,23 @@ AVInteger av_shr_i(AVInteger a, int s) av_const; /** - * Returns a % b. + * Return a % b. * @param quot a/b will be stored here. */ AVInteger av_mod_i(AVInteger *quot, AVInteger a, AVInteger b); /** - * Returns a/b. + * Return a/b. */ AVInteger av_div_i(AVInteger a, AVInteger b) av_const; /** - * Converts the given int64_t to an AVInteger. + * Convert the given int64_t to an AVInteger. */ AVInteger av_int2i(int64_t a) av_const; /** - * Converts the given AVInteger to an int64_t. + * Convert the given AVInteger to an int64_t. * If the AVInteger is too large to fit into an int64_t, * then only the least significant 64 bits will be used. */
--- a/internal.h Wed Jun 30 10:38:04 2010 +0000 +++ b/internal.h Wed Jun 30 15:38:06 2010 +0000 @@ -48,8 +48,8 @@ /** - * Marks a variable as used and prevents the compiler from optimizing it away. - * This is usefull for asm that accesses varibles in ways that the compiler doesnt + * Mark a variable as used and prevent the compiler from optimizing it away. + * This is useful for asm that accesses varibles in ways that the compiler does not * understand */ #ifndef attribute_used @@ -192,7 +192,7 @@ #include "libm.h" /** - * Returns NULL if CONFIG_SMALL is true, otherwise the argument + * Return NULL if CONFIG_SMALL is true, otherwise the argument * without modification. Used to disable the definition of strings * (for example AVCodec long_names). */
--- a/lfg.h Wed Jun 30 10:38:04 2010 +0000 +++ b/lfg.h Wed Jun 30 15:38:06 2010 +0000 @@ -30,7 +30,7 @@ void av_lfg_init(AVLFG *c, unsigned int seed); /** - * Gets the next random unsigned 32-bit number using an ALFG. + * Get the next random unsigned 32-bit number using an ALFG. * * Please also consider a simple LCG like state= state*1664525+1013904223, * it may be good enough and faster for your specific use case. @@ -41,7 +41,7 @@ } /** - * Gets the next random unsigned 32-bit number using a MLFG. + * Get the next random unsigned 32-bit number using a MLFG. * * Please also consider av_lfg_get() above, it is faster. */ @@ -52,7 +52,7 @@ } /** - * Gets the next two numbers generated by a Box-Muller Gaussian + * Get the next two numbers generated by a Box-Muller Gaussian * generator using the random numbers issued by lfg. * * @param out[2] array where are placed the two generated numbers
--- a/log.h Wed Jun 30 10:38:04 2010 +0000 +++ b/log.h Wed Jun 30 15:38:06 2010 +0000 @@ -25,7 +25,7 @@ #include "avutil.h" /** - * Describes the class of an AVClass context structure. That is an + * Describe the class of an AVClass context structure. That is an * arbitrary struct of which the first field is a pointer to an * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.). */ @@ -109,7 +109,7 @@ #define AV_LOG_DEBUG 48 /** - * Sends the specified message to the log if the level is less than or equal + * Send the specified message to the log if the level is less than or equal * to the current av_log_level. By default, all logging messages are sent to * stderr. This behavior can be altered by setting a different av_vlog callback * function.
--- a/mathematics.h Wed Jun 30 10:38:04 2010 +0000 +++ b/mathematics.h Wed Jun 30 15:38:06 2010 +0000 @@ -63,31 +63,31 @@ }; /** - * Returns the greatest common divisor of a and b. + * Return the greatest common divisor of a and b. * If both a and b are 0 or either or both are <0 then behavior is * undefined. */ int64_t av_const av_gcd(int64_t a, int64_t b); /** - * Rescales a 64-bit integer with rounding to nearest. + * Rescale a 64-bit integer with rounding to nearest. * A simple a*b/c isn't possible as it can overflow. */ int64_t av_rescale(int64_t a, int64_t b, int64_t c) av_const; /** - * Rescales a 64-bit integer with specified rounding. + * Rescale a 64-bit integer with specified rounding. * A simple a*b/c isn't possible as it can overflow. */ int64_t av_rescale_rnd(int64_t a, int64_t b, int64_t c, enum AVRounding) av_const; /** - * Rescales a 64-bit integer by 2 rational numbers. + * Rescale a 64-bit integer by 2 rational numbers. */ int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq) av_const; /** - * Compares 2 timestamps each in its own timebases. + * Compare 2 timestamps each in its own timebases. * The result of the function is undefined if one of the timestamps * is outside the int64_t range when represented in the others timebase. * @return -1 if ts_a is before ts_b, 1 if ts_a is after ts_b or 0 if they represent the same position @@ -95,7 +95,7 @@ int av_compare_ts(int64_t ts_a, AVRational tb_a, int64_t ts_b, AVRational tb_b); /** - * Compares 2 integers modulo mod. + * Compare 2 integers modulo mod. * That is we compare integers a and b for which only the least * significant log2(mod) bits are known. *
--- a/mem.h Wed Jun 30 10:38:04 2010 +0000 +++ b/mem.h Wed Jun 30 15:38:06 2010 +0000 @@ -63,7 +63,7 @@ #endif /** - * Allocates a block of size bytes with alignment suitable for all + * Allocate a block of size bytes with alignment suitable for all * memory accesses (including vectors if available on the CPU). * @param size Size in bytes for the memory block to be allocated. * @return Pointer to the allocated block, NULL if the block cannot @@ -73,9 +73,9 @@ void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1); /** - * Allocates or reallocates a block of memory. - * If ptr is NULL and size > 0, allocates a new block. If - * size is zero, frees the memory block pointed to by ptr. + * Allocate or reallocate a block of memory. + * If ptr is NULL and size > 0, allocate a new block. If + * size is zero, free the memory block pointed to by ptr. * @param size Size in bytes for the memory block to be allocated or * reallocated. * @param ptr Pointer to a memory block already allocated with @@ -87,7 +87,7 @@ void *av_realloc(void *ptr, unsigned int size) av_alloc_size(2); /** - * Frees a memory block which has been allocated with av_malloc(z)() or + * Free a memory block which has been allocated with av_malloc(z)() or * av_realloc(). * @param ptr Pointer to the memory block which should be freed. * @note ptr = NULL is explicitly allowed. @@ -97,9 +97,9 @@ void av_free(void *ptr); /** - * Allocates a block of size bytes with alignment suitable for all + * Allocate a block of size bytes with alignment suitable for all * memory accesses (including vectors if available on the CPU) and - * zeroes all the bytes of the block. + * zero all the bytes of the block. * @param size Size in bytes for the memory block to be allocated. * @return Pointer to the allocated block, NULL if it cannot be allocated. * @see av_malloc() @@ -107,7 +107,7 @@ void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1); /** - * Duplicates the string s. + * Duplicate the string s. * @param s string to be duplicated * @return Pointer to a newly allocated string containing a * copy of s or NULL if the string cannot be allocated. @@ -115,7 +115,7 @@ char *av_strdup(const char *s) av_malloc_attrib; /** - * Frees a memory block which has been allocated with av_malloc(z)() or + * Free a memory block which has been allocated with av_malloc(z)() or * av_realloc() and set the pointer pointing to it to NULL. * @param ptr Pointer to the pointer to the memory block which should * be freed.
--- a/pixdesc.h Wed Jun 30 10:38:04 2010 +0000 +++ b/pixdesc.h Wed Jun 30 15:38:06 2010 +0000 @@ -93,7 +93,7 @@ extern const AVPixFmtDescriptor av_pix_fmt_descriptors[]; /** - * Reads a line from an image, and writes the values of the + * Read a line from an image, and write the values of the * pixel format component c to dst. * * @param data the array containing the pointers to the planes of the image @@ -112,7 +112,7 @@ const AVPixFmtDescriptor *desc, int x, int y, int c, int w, int read_pal_component); /** - * Writes the values from src to the pixel format component c of an + * Write the values from src to the pixel format component c of an * image line. * * @param src array containing the values to write @@ -129,7 +129,7 @@ const AVPixFmtDescriptor *desc, int x, int y, int c, int w); /** - * Returns the pixel format corresponding to name. + * Return the pixel format corresponding to name. * * If there is no pixel format with name name, then looks for a * pixel format with the name corresponding to the native endian @@ -142,7 +142,7 @@ enum PixelFormat av_get_pix_fmt(const char *name); /** - * Returns the number of bits per pixel used by the pixel format + * Return the number of bits per pixel used by the pixel format * described by pixdesc. * * The returned number of bits refers to the number of bits actually
--- a/random_seed.h Wed Jun 30 10:38:04 2010 +0000 +++ b/random_seed.h Wed Jun 30 15:38:06 2010 +0000 @@ -24,7 +24,7 @@ #include <stdint.h> /** - * Gets a seed to use in conjunction with random functions. + * Get a seed to use in conjunction with random functions. */ uint32_t av_get_random_seed(void);
--- a/rational.h Wed Jun 30 10:38:04 2010 +0000 +++ b/rational.h Wed Jun 30 15:38:06 2010 +0000 @@ -40,7 +40,7 @@ } AVRational; /** - * Compares two rationals. + * Compare two rationals. * @param a first rational * @param b second rational * @return 0 if a==b, 1 if a>b and -1 if a<b @@ -53,7 +53,7 @@ } /** - * Converts rational to double. + * Convert rational to double. * @param a rational to convert * @return (double) a */ @@ -62,7 +62,7 @@ } /** - * Reduces a fraction. + * Reduce a fraction. * This is useful for framerate calculations. * @param dst_num destination numerator * @param dst_den destination denominator @@ -74,7 +74,7 @@ int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max); /** - * Multiplies two rationals. + * Multiply two rationals. * @param b first rational * @param c second rational * @return b*c @@ -82,7 +82,7 @@ AVRational av_mul_q(AVRational b, AVRational c) av_const; /** - * Divides one rational by another. + * Divide one rational by another. * @param b first rational * @param c second rational * @return b/c @@ -90,7 +90,7 @@ AVRational av_div_q(AVRational b, AVRational c) av_const; /** - * Adds two rationals. + * Add two rationals. * @param b first rational * @param c second rational * @return b+c @@ -98,7 +98,7 @@ AVRational av_add_q(AVRational b, AVRational c) av_const; /** - * Subtracts one rational from another. + * Subtract one rational from another. * @param b first rational * @param c second rational * @return b-c @@ -106,7 +106,7 @@ AVRational av_sub_q(AVRational b, AVRational c) av_const; /** - * Converts a double precision floating point number to a rational. + * Convert a double precision floating point number to a rational. * @param d double to convert * @param max the maximum allowed numerator and denominator * @return (AVRational) d @@ -120,7 +120,7 @@ int av_nearer_q(AVRational q, AVRational q1, AVRational q2); /** - * Finds the nearest value in q_list to q. + * Find the nearest value in q_list to q. * @param q_list an array of rationals terminated by {0, 0} * @return the index of the nearest value found in the array */
--- a/sha.h Wed Jun 30 10:38:04 2010 +0000 +++ b/sha.h Wed Jun 30 15:38:06 2010 +0000 @@ -28,7 +28,7 @@ struct AVSHA; /** - * Initializes SHA-1 or SHA-2 hashing. + * Initialize SHA-1 or SHA-2 hashing. * * @param context pointer to the function context (of size av_sha_size) * @param bits number of bits in digest (SHA-1 - 160 bits, SHA-2 224 or 256 bits) @@ -37,7 +37,7 @@ int av_sha_init(struct AVSHA* context, int bits); /** - * Updates hash value. + * Update hash value. * * @param context hash function context * @param data input data to update hash with @@ -46,7 +46,7 @@ void av_sha_update(struct AVSHA* context, const uint8_t* data, unsigned int len); /** - * Finishes hashing and output digest value. + * Finish hashing and output digest value. * * @param context hash function context * @param digest buffer where output digest value is stored
--- a/sha1.h Wed Jun 30 10:38:04 2010 +0000 +++ b/sha1.h Wed Jun 30 15:38:06 2010 +0000 @@ -28,7 +28,7 @@ struct AVSHA1; /** - * Initializes SHA-1 hashing. + * Initialize SHA-1 hashing. * * @param context pointer to the function context (of size av_sha_size) * @deprecated use av_sha_init() instead @@ -36,7 +36,7 @@ void av_sha1_init(struct AVSHA1* context); /** - * Updates hash value. + * Update hash value. * * @param context hash function context * @param data input data to update hash with @@ -46,7 +46,7 @@ void av_sha1_update(struct AVSHA1* context, const uint8_t* data, unsigned int len); /** - * Finishes hashing and output digest value. + * Finish hashing and output digest value. * * @param context hash function context * @param digest buffer where output digest value is stored
--- a/tree.h Wed Jun 30 10:38:04 2010 +0000 +++ b/tree.h Wed Jun 30 15:38:06 2010 +0000 @@ -33,7 +33,7 @@ extern const int av_tree_node_size; /** - * Finds an element. + * Find an element. * @param root a pointer to the root node of the tree * @param next If next is not NULL, then next[0] will contain the previous * element and next[1] the next element. If either does not exist, @@ -44,7 +44,7 @@ void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *key, const void *b), void *next[2]); /** - * Inserts or removes an element. + * Insert or remove an element. * If *next is NULL, then the supplied element will be removed if it exists. * If *next is not NULL, then the supplied element will be inserted, unless * it already exists in the tree. @@ -80,7 +80,7 @@ void av_tree_destroy(struct AVTreeNode *t); /** - * Applies enu(opaque, &elem) to all the elements in the tree in a given range. + * Apply enu(opaque, &elem) to all the elements in the tree in a given range. * * @param cmp a comparison function that returns < 0 for a element below the * range, > 0 for a element above the range and == 0 for a