LineageOS/android_external_libvpx
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

vp8[cd]x.h: document vpx_codec_vp[89]_[cd]x*

Browse Source 
+ mark the _algo variables as deprecated.
this quiets some doxygen warnings

Bug: webm:1752
Change-Id: I53b9b796c3d8fef5c713ee4278641198f95b5864
This commit is contained in:
James Zern
2022-05-06 11:47:06 -07:00
parent 8ac72859e1
commit f3b4c9a8f6
2 changed files with 32 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
vpx/vp8cx.h
View File

@@ -33,7 +33,15 @@ extern "C" {
* This interface provides the capability to encode raw VP8 streams.
* @{
*/
/*!\brief A single instance of the VP8 encoder.
*\deprecated This access mechanism is provided for backwards compatibility;
* prefer vpx_codec_vp8_cx().
*/
extern vpx_codec_iface_t vpx_codec_vp8_cx_algo;
/*!\brief The interface to the VP8 encoder.
*/
extern vpx_codec_iface_t *vpx_codec_vp8_cx(void);
/*!@} - end algorithm interface member group*/
@@ -42,7 +50,15 @@ extern vpx_codec_iface_t *vpx_codec_vp8_cx(void);
* This interface provides the capability to encode raw VP9 streams.
* @{
*/
/*!\brief A single instance of the VP9 encoder.
*\deprecated This access mechanism is provided for backwards compatibility;
* prefer vpx_codec_vp9_cx().
*/
extern vpx_codec_iface_t vpx_codec_vp9_cx_algo;
/*!\brief The interface to the VP9 encoder.
*/
extern vpx_codec_iface_t *vpx_codec_vp9_cx(void);
/*!@} - end algorithm interface member group*/

16
vpx/vp8dx.h
View File

@@ -32,7 +32,15 @@ extern "C" {
* This interface provides the capability to decode VP8 streams.
* @{
*/
/*!\brief A single instance of the VP8 decoder.
*\deprecated This access mechanism is provided for backwards compatibility;
* prefer vpx_codec_vp8_dx().
*/
extern vpx_codec_iface_t vpx_codec_vp8_dx_algo;
/*!\brief The interface to the VP8 decoder.
*/
extern vpx_codec_iface_t *vpx_codec_vp8_dx(void);
/*!@} - end algorithm interface member group*/
@@ -41,7 +49,15 @@ extern vpx_codec_iface_t *vpx_codec_vp8_dx(void);
* This interface provides the capability to decode VP9 streams.
* @{
*/
/*!\brief A single instance of the VP9 decoder.
*\deprecated This access mechanism is provided for backwards compatibility;
* prefer vpx_codec_vp9_dx().
*/
extern vpx_codec_iface_t vpx_codec_vp9_dx_algo;
/*!\brief The interface to the VP9 decoder.
*/
extern vpx_codec_iface_t *vpx_codec_vp9_dx(void);
/*!@} - end algorithm interface member group*/