# HG changeset patch # User mru # Date 1277912286 0 # Node ID e34e8d654ded952649e5408f62ac565ed9e726ab # Parent 2894d4c208dc96f3c4840078059552b7a20aeab1 Fix grammar errors in documentation diff -r 2894d4c208dc -r e34e8d654ded aes.h --- 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 diff -r 2894d4c208dc -r e34e8d654ded avutil.h --- 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); diff -r 2894d4c208dc -r e34e8d654ded base64.h --- 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 /** - * 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 diff -r 2894d4c208dc -r e34e8d654ded common.h --- 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. diff -r 2894d4c208dc -r e34e8d654ded crc.c --- 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 * diff -r 2894d4c208dc -r e34e8d654ded error.h --- 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. diff -r 2894d4c208dc -r e34e8d654ded eval.h --- 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, diff -r 2894d4c208dc -r e34e8d654ded fifo.h --- 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 */ diff -r 2894d4c208dc -r e34e8d654ded integer.h --- 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 ab and -1 if a 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. diff -r 2894d4c208dc -r e34e8d654ded pixdesc.h --- 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 diff -r 2894d4c208dc -r e34e8d654ded random_seed.h --- 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 /** - * 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); diff -r 2894d4c208dc -r e34e8d654ded rational.h --- 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 0 for a element above the range and == 0 for a