mainpage.dox

   1 /*!\mainpage WebM VP8 Codec SDK
   2
   3   \section main_contents Page Contents
   4   - \ref main_intro
   5   - \ref main_startpoints
   6   - \ref main_support
   7
   8   \section main_intro Introduction
   9   Welcome to the WebM VP8 Codec SDK. This SDK allows you to integrate your
  10   applications with the VP8 video codec, a high quality, royalty free, open
  11   source codec deployed on millions of computers and devices worldwide.
  12
  13   This distribution of the WebM VP8 Codec SDK includes the following support:
  14
  15   \if vp8_encoder
  16   - \ref vp8_encoder
  17   \endif
  18   \if vp8_decoder
  19   - \ref vp8_decoder
  20   \endif
  21
  22
  23   \section main_startpoints Starting Points
  24   - Consult the \ref changelog for a complete list of improvements in this
  25     release.
  26   - The \ref readme contains instructions on recompiling the sample applications.
  27   - Read the \ref usage "usage" for a narrative on codec usage.
  28   - Read the \ref samples "sample code" for examples of how to interact with the
  29     codec.
  30   - \ref codec reference
  31     \if encoder
  32     - \ref encoder reference
  33     \endif
  34     \if decoder
  35     - \ref decoder reference
  36     \endif
  37
  38   \section main_support Support Options & FAQ
  39   The WebM project is an open source project supported by its community. For
  40   questions about this SDK, please mail the apps-devel@webmproject.org list.
  41   To contribute, see http://www.webmproject.org/code/contribute and mail
  42   codec-devel@webmproject.org.
  43 */
  44
  45 /*!\page changelog CHANGELOG
  46    \verbinclude CHANGELOG
  47 */
  48
  49 /*!\page readme README
  50    \verbinclude README
  51 */
  52
  53 /*!\defgroup codecs Supported Codecs */