mainpage.dox

   1 /*!\mainpage WebM 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 Codec SDK. This SDK allows you to integrate your
  10   applications with the VP8 and VP9 video codecs, high quality, royalty free,
  11   open source codecs deployed on billions of computers and devices worldwide.
  12
  13   This distribution of the WebM 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   \if samples
  29   - Read the \ref samples "sample code" for examples of how to interact with the
  30     codec.
  31   \endif
  32   - \ref codec reference
  33   \if encoder
  34   - \ref encoder reference
  35   \endif
  36   \if decoder
  37   - \ref decoder reference
  38   \endif
  39
  40   \section main_support Support Options & FAQ
  41   The WebM project is an open source project supported by its community. For
  42   questions about this SDK, please mail the apps-devel@webmproject.org list.
  43   To contribute, see http://www.webmproject.org/code/contribute and mail
  44   codec-devel@webmproject.org.
  45 */
  46
  47 /*!\page changelog CHANGELOG
  48    \verbinclude CHANGELOG
  49 */
  50
  51 /*!\page readme README
  52    \verbinclude README
  53 */
  54
  55 /*!\defgroup codecs Supported Codecs */