From f5bbe244aa7f7c69b80e85c848d8974df5004555 Mon Sep 17 00:00:00 2001 From: Yaowu Xu Date: Thu, 15 Jan 2015 14:32:42 -0800 Subject: [PATCH] Fix obvious misses in doxygen mainpage Change-Id: I0537769904f0853c9299b36a91391f289acf442c --- libs.doxy_template | 2 +- mainpage.dox | 22 +++++++++++----------- vpx/vp8cx.h | 15 +++++++++------ vpx/vp8dx.h | 14 +++++++++----- 4 files changed, 30 insertions(+), 23 deletions(-) diff --git a/libs.doxy_template b/libs.doxy_template index 370bf827e..5a8f84728 100644 --- a/libs.doxy_template +++ b/libs.doxy_template @@ -36,7 +36,7 @@ DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = "WebM VP8 Codec SDK" +PROJECT_NAME = "WebM Codec SDK" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. diff --git a/mainpage.dox b/mainpage.dox index e2ec28002..ec202fa4f 100644 --- a/mainpage.dox +++ b/mainpage.dox @@ -1,4 +1,4 @@ -/*!\mainpage WebM VP8 Codec SDK +/*!\mainpage WebM Codec SDK \section main_contents Page Contents - \ref main_intro @@ -6,11 +6,11 @@ - \ref main_support \section main_intro Introduction - Welcome to the WebM VP8 Codec SDK. This SDK allows you to integrate your - applications with the VP8 video codec, a high quality, royalty free, open - source codec deployed on millions of computers and devices worldwide. + Welcome to the WebM Codec SDK. This SDK allows you to integrate your + applications with the VP8 and VP9 video codecs, high quality, royalty free, + open source codecs deployed on billions of computers and devices worldwide. - This distribution of the WebM VP8 Codec SDK includes the following support: + This distribution of the WebM Codec SDK includes the following support: \if vp8_encoder - \ref vp8_encoder @@ -28,12 +28,12 @@ - Read the \ref samples "sample code" for examples of how to interact with the codec. - \ref codec reference - \if encoder - - \ref encoder reference - \endif - \if decoder - - \ref decoder reference - \endif + \if encoder + - \ref encoder reference + \endif + \if decoder + - \ref decoder reference + \endif \section main_support Support Options & FAQ The WebM project is an open source project supported by its community. For diff --git a/vpx/vp8cx.h b/vpx/vp8cx.h index 75caad8ba..a920ee3f9 100644 --- a/vpx/vp8cx.h +++ b/vpx/vp8cx.h @@ -10,7 +10,7 @@ #ifndef VPX_VP8CX_H_ #define VPX_VP8CX_H_ -/*!\defgroup vp8_encoder WebM VP8 Encoder +/*!\defgroup vp8_encoder WebM VP8/VP9 Encoder * \ingroup vp8 * * @{ @@ -18,7 +18,7 @@ #include "./vp8.h" /*!\file - * \brief Provides definitions for using the VP8 encoder algorithm within the + * \brief Provides definitions for using VP8 or VP9 encoder algorithm within the * vpx Codec Interface. */ @@ -28,17 +28,20 @@ extern "C" { /*!\name Algorithm interface for VP8 * - * This interface provides the capability to encode raw VP8 streams, as would - * be found in AVI files. + * This interface provides the capability to encode raw VP8 streams. * @{ */ extern vpx_codec_iface_t vpx_codec_vp8_cx_algo; extern vpx_codec_iface_t *vpx_codec_vp8_cx(void); +/*!@} - end algorithm interface member group*/ -/* TODO(jkoleszar): These move to VP9 in a later patch set. */ +/*!\name Algorithm interface for VP9 + * + * This interface provides the capability to encode raw VP9 streams. + * @{ + */ extern vpx_codec_iface_t vpx_codec_vp9_cx_algo; extern vpx_codec_iface_t *vpx_codec_vp9_cx(void); - /*!@} - end algorithm interface member group*/ diff --git a/vpx/vp8dx.h b/vpx/vp8dx.h index c5475c478..3ba72fe3c 100644 --- a/vpx/vp8dx.h +++ b/vpx/vp8dx.h @@ -9,13 +9,13 @@ */ -/*!\defgroup vp8_decoder WebM VP8 Decoder +/*!\defgroup vp8_decoder WebM VP8/VP9 Decoder * \ingroup vp8 * * @{ */ /*!\file - * \brief Provides definitions for using the VP8 algorithm within the vpx Decoder + * \brief Provides definitions for using VP8 or VP9 within the vpx Decoder * interface. */ #ifndef VPX_VP8DX_H_ @@ -30,14 +30,18 @@ extern "C" { /*!\name Algorithm interface for VP8 * - * This interface provides the capability to decode raw VP8 streams, as would - * be found in AVI files and other non-Flash uses. + * This interface provides the capability to decode VP8 streams. * @{ */ extern vpx_codec_iface_t vpx_codec_vp8_dx_algo; extern vpx_codec_iface_t *vpx_codec_vp8_dx(void); +/*!@} - end algorithm interface member group*/ -/* TODO(jkoleszar): These move to VP9 in a later patch set. */ +/*!\name Algorithm interface for VP9 + * + * This interface provides the capability to decode VP9 streams. + * @{ + */ extern vpx_codec_iface_t vpx_codec_vp9_dx_algo; extern vpx_codec_iface_t *vpx_codec_vp9_dx(void); /*!@} - end algorithm interface member group*/ -- 2.40.0