mainpage.dox 1.5 KB

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