doc/encode: link modules from the main page.
authorGwenole Beauchesne <gwenole.beauchesne@intel.com>
Fri, 18 Nov 2011 12:52:29 +0000 (12:52 +0000)
committerXiang, Haihao <haihao.xiang@intel.com>
Tue, 28 May 2013 08:45:46 +0000 (16:45 +0800)
va/va.h

diff --git a/va/va.h b/va/va.h
index 3401878..0d4f7cc 100644 (file)
--- a/va/va.h
+++ b/va/va.h
@@ -85,6 +85,23 @@ extern "C" {
 #endif
 
 /**
+ * \mainpage Video Acceleration (VA) API
+ *
+ * \section intro Introduction
+ *
+ * The main motivation for VA-API (Video Acceleration API) is to
+ * enable hardware accelerated video decode and encode at various
+ * entry-points (VLD, IDCT, Motion Compensation etc.) for the
+ * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
+ * AVC/H.264, VC-1/VMW3, and JPEG).
+ *
+ * VA-API is split into several modules:
+ * - \ref api_core
+ * - \ref api_enc_core
+ * - \ref api_enc_h264
+ */
+
+/**
  * \defgroup api_core Core API
  *
  * @{