mainpage.dox

   1 /*!\mainpage AMedia 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 AMedia Codec SDK. This SDK allows you to integrate your
  10   applications with the AOM and AV1 video codecs.
  11
  12   This distribution of the AOMedia Codec SDK includes the following support:
  13
  14   \if aom_encoder
  15   - \ref aom_encoder
  16   \endif
  17   \if aom_decoder
  18   - \ref aom_decoder
  19   \endif
  20
  21
  22   \section main_startpoints Starting Points
  23   - Consult the \ref changelog for a complete list of improvements in this
  24     release.
  25   - \ref readme contains instructions on compiling the sample applications.
  26   - Read the \ref usage "usage" for a narrative on codec usage.
  27   - Read the \ref samples "sample code" for examples of how to interact with the
  28     codec.
  29   - \ref codec reference
  30   \if encoder
  31   - \ref encoder reference
  32   \endif
  33   \if decoder
  34   - \ref decoder reference
  35   \endif
  36
  37   \section main_support Support Options & FAQ
  38   The AOMedia project is an open source project supported by its community. For
  39   questions about this SDK, please mail the apps-devel@webmproject.org list.
  40   To contribute, see http://www.webmproject.org/code/contribute and mail
  41   codec-devel@webmproject.org.
  42 */
  43
  44 /*!\page changelog CHANGELOG
  45    \verbinclude CHANGELOG
  46 */
  47
  48 /*!\page readme README.md
  49    \include README.md
  50 */
  51
  52 /*!\defgroup codecs Supported Codecs */