documentation: minor cosmetics
- correct spelling
- remove explicit file name w/\file (unnecessary when contained in the
same file and prone to desync)
Change-Id: I68a3960ac5ab84d0f2e5c9b2e29799f26dfccf23
diff --git a/vpx/internal/vpx_codec_internal.h b/vpx/internal/vpx_codec_internal.h
index 9cde426..470ea73 100644
--- a/vpx/internal/vpx_codec_internal.h
+++ b/vpx/internal/vpx_codec_internal.h
@@ -9,7 +9,7 @@
*/
-/*!\file decoder_impl.h
+/*!\file
* \brief Describes the decoder algorithm interface for algorithm
* implementations.
*
@@ -214,7 +214,7 @@
vpx_codec_iter_t *iter);
-/*\brief e_xternal Memory Allocation memory map get iterator
+/*\brief eXternal Memory Allocation memory map get iterator
*
* Iterates over a list of the memory maps requested by the decoder. The
* iterator storage should be initialized to NULL to start the iteration.
@@ -230,7 +230,7 @@
vpx_codec_iter_t *iter);
-/*\brief e_xternal Memory Allocation memory map set iterator
+/*\brief eXternal Memory Allocation memory map set iterator
*
* Sets a memory descriptor inside the decoder instance.
*
@@ -405,7 +405,7 @@
/* Internal Utility Functions
*
- * The following functions are indended to be used inside algorithms as
+ * The following functions are intended to be used inside algorithms as
* utilities for manipulating vpx_codec_* data structures.
*/
struct vpx_codec_pkt_list
diff --git a/vpx/src/vpx_codec.c b/vpx/src/vpx_codec.c
index 9c1558c..f1a8b67 100644
--- a/vpx/src/vpx_codec.c
+++ b/vpx/src/vpx_codec.c
@@ -9,7 +9,7 @@
*/
-/*!\file vpx_decoder.c
+/*!\file
* \brief Provides the high level interface to wrap decoder algorithms.
*
*/
diff --git a/vpx/src/vpx_decoder.c b/vpx/src/vpx_decoder.c
index 7b78e5c..fe6ea75 100644
--- a/vpx/src/vpx_decoder.c
+++ b/vpx/src/vpx_decoder.c
@@ -9,7 +9,7 @@
*/
-/*!\file vpx_decoder.c
+/*!\file
* \brief Provides the high level interface to wrap decoder algorithms.
*
*/
diff --git a/vpx/src/vpx_decoder_compat.c b/vpx/src/vpx_decoder_compat.c
index e264734..4fe00ce 100644
--- a/vpx/src/vpx_decoder_compat.c
+++ b/vpx/src/vpx_decoder_compat.c
@@ -9,7 +9,7 @@
*/
-/*!\file vpx_decoder.c
+/*!\file
* \brief Provides the high level interface to wrap decoder algorithms.
*
*/
diff --git a/vpx/src/vpx_encoder.c b/vpx/src/vpx_encoder.c
index 1092959..db778ff 100644
--- a/vpx/src/vpx_encoder.c
+++ b/vpx/src/vpx_encoder.c
@@ -9,7 +9,7 @@
*/
-/*!\file vpx_encoder.c
+/*!\file
* \brief Provides the high level interface to wrap encoder algorithms.
*
*/
diff --git a/vpx/vp8.h b/vpx/vp8.h
index 32c0132..430f909 100644
--- a/vpx/vp8.h
+++ b/vpx/vp8.h
@@ -14,7 +14,7 @@
* VP8 is vpx's newest video compression algorithm that uses motion
* compensated prediction, Discrete Cosine Transform (DCT) coding of the
* prediction error signal and context dependent entropy coding techniques
- * based on arithmatic principles. It features:
+ * based on arithmetic principles. It features:
* - YUV 4:2:0 image format
* - Macro-block based coding (16x16 luma plus two 8x8 chroma)
* - 1/4 (1/8) pixel accuracy motion compensated prediction
@@ -25,7 +25,7 @@
*
* @{
*/
-/*!\file vp8.h
+/*!\file
* \brief Provides controls common to both the VP8 encoder and decoder.
*/
#ifndef VP8_H
@@ -67,7 +67,7 @@
/*!\brief post process flags
*
* This define a structure that describe the post processing settings. For
- * the best objective measure (using thet PSNR metric) set post_proc_flag
+ * the best objective measure (using the PSNR metric) set post_proc_flag
* to VP8_DEBLOCK and deblocking_level to 1.
*/
@@ -101,7 +101,7 @@
} vpx_ref_frame_t;
-/*!\brief vp8 decoder control funciton parameter type
+/*!\brief vp8 decoder control function parameter type
*
* defines the data type for each of VP8 decoder control function requires
*/
diff --git a/vpx/vp8cx.h b/vpx/vp8cx.h
index d574c44..8e07547 100644
--- a/vpx/vp8cx.h
+++ b/vpx/vp8cx.h
@@ -16,7 +16,7 @@
*/
#include "vp8.h"
-/*!\file vp8cx.h
+/*!\file
* \brief Provides definitions for using the VP8 encoder algorithm within the
* vpx Codec Interface.
*/
diff --git a/vpx/vp8dx.h b/vpx/vp8dx.h
index 16bc07c..a2a0dd1 100644
--- a/vpx/vp8dx.h
+++ b/vpx/vp8dx.h
@@ -16,7 +16,7 @@
*
* @{
*/
-/*!\file vp8dx.h
+/*!\file
* \brief Provides definitions for using the VP8 algorithm within the vpx Decoder
* interface.
*/
diff --git a/vpx/vpx_codec.h b/vpx/vpx_codec.h
index 899b27c..4d58bf8 100644
--- a/vpx/vpx_codec.h
+++ b/vpx/vpx_codec.h
@@ -16,7 +16,7 @@
* @{
*/
-/*!\file vpx_codec.h
+/*!\file
* \brief Describes the codec algorithm interface to applications.
*
* This file describes the interface between an application and a
@@ -145,7 +145,7 @@
typedef long vpx_codec_caps_t;
#define VPX_CODEC_CAP_DECODER 0x1 /**< Is a decoder */
#define VPX_CODEC_CAP_ENCODER 0x2 /**< Is an encoder */
-#define VPX_CODEC_CAP_XMA 0x4 /**< Supports e_xternal Memory Allocation */
+#define VPX_CODEC_CAP_XMA 0x4 /**< Supports eXternal Memory Allocation */
/*! \brief Initialization-time Feature Enabling
@@ -156,7 +156,7 @@
* The available flags are specified by VPX_CODEC_USE_* defines.
*/
typedef long vpx_codec_flags_t;
-#define VPX_CODEC_USE_XMA 0x00000001 /**< Use e_xternal Memory Allocation mode */
+#define VPX_CODEC_USE_XMA 0x00000001 /**< Use eXternal Memory Allocation mode */
/*!\brief Codec interface structure.
@@ -232,7 +232,7 @@
/*!\brief Return the version major number */
#define vpx_codec_version_major() ((vpx_codec_version()>>16)&0xff)
- /*!\brief Return the version minr number */
+ /*!\brief Return the version minor number */
#define vpx_codec_version_minor() ((vpx_codec_version()>>8)&0xff)
/*!\brief Return the version patch number */
@@ -338,9 +338,9 @@
/*!\brief Get the capabilities of an algorithm.
*
- * Retrieves the capabliities bitfield from the algorithm's interface.
+ * Retrieves the capabilities bitfield from the algorithm's interface.
*
- * \param[in] iface Pointer to the alogrithm interface
+ * \param[in] iface Pointer to the algorithm interface
*
*/
vpx_codec_caps_t vpx_codec_get_caps(vpx_codec_iface_t *iface);
@@ -354,7 +354,7 @@
*
* This wrapper function dispatches the request to the helper function
* associated with the given ctrl_id. It tries to call this function
- * transparantly, but will return #VPX_CODEC_ERROR if the request could not
+ * transparently, but will return #VPX_CODEC_ERROR if the request could not
* be dispatched.
*
* Note that this function should not be used directly. Call the
@@ -525,7 +525,7 @@
* passed in the order they are read from vpx_codec_get_mem_map(), but may be
* passed in groups of any size. Segments \ref MUST be set only once. The
* allocation function \ref MUST ensure that the vpx_codec_mmap_t::base member
- * is non-NULL. If the segment requires cleanup handling (eg, calling free()
+ * is non-NULL. If the segment requires cleanup handling (e.g., calling free()
* or close()) then the vpx_codec_mmap_t::dtor member \ref MUST be populated.
*
* \param[in] ctx Pointer to this instance's context.
diff --git a/vpx/vpx_decoder.h b/vpx/vpx_decoder.h
index 6ffc2d4..4c57409 100644
--- a/vpx/vpx_decoder.h
+++ b/vpx/vpx_decoder.h
@@ -17,7 +17,7 @@
* @{
*/
-/*!\file vpx_decoder.h
+/*!\file
* \brief Describes the decoder algorithm interface to applications.
*
* This file describes the interface between an application and a
@@ -48,7 +48,7 @@
* ::vpx_codec_iface_t interface structure. Capabilities are extra interfaces
* or functionality, and are not required to be supported by a decoder.
*
- * The available flags are specifiedby VPX_CODEC_CAP_* defines.
+ * The available flags are specified by VPX_CODEC_CAP_* defines.
*/
#define VPX_CODEC_CAP_PUT_SLICE 0x10000 /**< Will issue put_slice callbacks */
#define VPX_CODEC_CAP_PUT_FRAME 0x20000 /**< Will issue put_frame callbacks */
@@ -109,7 +109,7 @@
* kept readable and stable until all memory maps have been set.
*
* \param[in] ctx Pointer to this instance's context.
- * \param[in] iface Pointer to the alogrithm interface to use.
+ * \param[in] iface Pointer to the algorithm interface to use.
* \param[in] cfg Configuration to use, if known. May be NULL.
* \param[in] flags Bitfield of VPX_CODEC_USE_* flags
* \param[in] ver ABI version number. Must be set to
@@ -139,7 +139,7 @@
* context is not necessary. Can be used to determine if the bitstream is
* of the proper format, and to extract information from the stream.
*
- * \param[in] iface Pointer to the alogrithm interface
+ * \param[in] iface Pointer to the algorithm interface
* \param[in] data Pointer to a block of data to parse
* \param[in] data_sz Size of the data buffer
* \param[in,out] si Pointer to stream info to update. The size member
diff --git a/vpx/vpx_decoder_compat.h b/vpx/vpx_decoder_compat.h
index ca6f618..0fec327 100644
--- a/vpx/vpx_decoder_compat.h
+++ b/vpx/vpx_decoder_compat.h
@@ -16,7 +16,7 @@
* @{
*/
-/*!\file vpx_decoder_compat.h
+/*!\file
* \brief Provides a compatibility layer between version 1 and 2 of this API.
*
* This interface has been deprecated. Only existing code should make use
@@ -89,12 +89,12 @@
* ::vpx_dec_iface_t interface structure. Capabilities are extra interfaces
* or functionality, and are not required to be supported by a decoder.
*
- * The available flags are specifiedby VPX_DEC_CAP_* defines.
+ * The available flags are specified by VPX_DEC_CAP_* defines.
*/
typedef int vpx_dec_caps_t;
#define VPX_DEC_CAP_PUT_SLICE 0x0001 /**< Will issue put_slice callbacks */
#define VPX_DEC_CAP_PUT_FRAME 0x0002 /**< Will issue put_frame callbacks */
-#define VPX_DEC_CAP_XMA 0x0004 /**< Supports e_xternal Memory Allocation */
+#define VPX_DEC_CAP_XMA 0x0004 /**< Supports eXternal Memory Allocation */
/*!\brief Stream properties
*
@@ -222,7 +222,7 @@
* is properly initialized.
*
* \param[in] ctx Pointer to this instance's context.
- * \param[in] iface Pointer to the alogrithm interface to use.
+ * \param[in] iface Pointer to the algorithm interface to use.
* \param[in] ver ABI version number. Must be set to
* VPX_DECODER_ABI_VERSION
* \retval #VPX_DEC_OK
@@ -253,9 +253,9 @@
/*!\brief Get the capabilities of an algorithm.
*
- * Retrieves the capabliities bitfield from the algorithm's interface.
+ * Retrieves the capabilities bitfield from the algorithm's interface.
*
- * \param[in] iface Pointer to the alogrithm interface
+ * \param[in] iface Pointer to the algorithm interface
*
*/
vpx_dec_caps_t vpx_dec_get_caps(vpx_dec_iface_t *iface) DEPRECATED;
@@ -267,7 +267,7 @@
* context is not necessary. Can be used to determine if the bitstream is
* of the proper format, and to extract information from the stream.
*
- * \param[in] iface Pointer to the alogrithm interface
+ * \param[in] iface Pointer to the algorithm interface
* \param[in] data Pointer to a block of data to parse
* \param[in] data_sz Size of the data buffer
* \param[in,out] si Pointer to stream info to update. The size member
@@ -309,7 +309,7 @@
*
* This wrapper function dispatches the request to the helper function
* associated with the given ctrl_id. It tries to call this function
- * transparantly, but will return #VPX_DEC_ERROR if the request could not
+ * transparently, but will return #VPX_DEC_ERROR if the request could not
* be dispatched.
*
* \param[in] ctx Pointer to this instance's context
@@ -507,7 +507,7 @@
* is properly initialized.
*
* \param[in] ctx Pointer to this instance's context.
- * \param[in] iface Pointer to the alogrithm interface to use.
+ * \param[in] iface Pointer to the algorithm interface to use.
* \param[in] ver ABI version number. Must be set to
* VPX_DECODER_ABI_VERSION
* \retval #VPX_DEC_OK
@@ -558,7 +558,7 @@
* passed in the order they are read from vpx_dec_get_mem_map(), but may be
* passed in groups of any size. Segments \ref MUST be set only once. The
* allocation function \ref MUST ensure that the vpx_dec_mmap_t::base member
- * is non-NULL. If the segment requires cleanup handling (eg, calling free()
+ * is non-NULL. If the segment requires cleanup handling (e.g., calling free()
* or close()) then the vpx_dec_mmap_t::dtor member \ref MUST be populated.
*
* \param[in] ctx Pointer to this instance's context.
diff --git a/vpx/vpx_encoder.h b/vpx/vpx_encoder.h
index 0d53f41..9c44414 100644
--- a/vpx/vpx_encoder.h
+++ b/vpx/vpx_encoder.h
@@ -17,7 +17,7 @@
* @{
*/
-/*!\file vpx_encoder.h
+/*!\file
* \brief Describes the encoder algorithm interface to applications.
*
* This file describes the interface between an application and a
@@ -51,7 +51,7 @@
* interfaces or functionality, and are not required to be supported
* by an encoder.
*
- * The available flags are specifiedby VPX_CODEC_CAP_* defines.
+ * The available flags are specified by VPX_CODEC_CAP_* defines.
*/
#define VPX_CODEC_CAP_PSNR 0x10000 /**< Can issue PSNR packets */
@@ -147,7 +147,7 @@
/* This packet size is fixed to allow codecs to extend this
* interface without having to manage storage for raw packets,
- * ie if it's smaller than 128 bytes, you can store in the
+ * i.e., if it's smaller than 128 bytes, you can store in the
* packet list directly.
*/
char pad[128 - sizeof(enum vpx_codec_cx_pkt_kind)]; /**< fixed sz */
diff --git a/vpx/vpx_image.h b/vpx/vpx_image.h
index dcb8f31..8e08b36 100644
--- a/vpx/vpx_image.h
+++ b/vpx/vpx_image.h
@@ -9,7 +9,7 @@
*/
-/*!\file vpx_image.h
+/*!\file
* \brief Describes the vpx image descriptor and associated operations
*
*/
@@ -33,7 +33,7 @@
#define VPX_IMG_FMT_PLANAR 0x100 /**< Image is a planar format */
#define VPX_IMG_FMT_UV_FLIP 0x200 /**< V plane precedes U plane in memory */
-#define VPX_IMG_FMT_HAS_ALPHA 0x400 /**< Image has an alpha channel componnent */
+#define VPX_IMG_FMT_HAS_ALPHA 0x400 /**< Image has an alpha channel component */
/*!\brief List of supported image formats */
@@ -115,7 +115,7 @@
#define VPX_PLANE_Y 0 /**< Y (Luminance) plane */
#define VPX_PLANE_U 1 /**< U (Chroma) plane */
#define VPX_PLANE_V 2 /**< V (Chroma) plane */
-#define VPX_PLANE_ALPHA 3 /**< A (Transparancy) plane */
+#define VPX_PLANE_ALPHA 3 /**< A (Transparency) plane */
#if !defined(VPX_CODEC_DISABLE_COMPAT) || !VPX_CODEC_DISABLE_COMPAT
#define PLANE_PACKED VPX_PLANE_PACKED
#define PLANE_Y VPX_PLANE_Y
