From: Marco Paniconi <marpan@google.com>
Date: Wed, 19 Feb 2014 01:31:57 +0000 (-0800)
Subject: Add comments to portion of SVC interface.
X-Git-Tag: v1.4.0~2342
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=89ec99042109fe380b4baf3714cbbbdd8d2b8e27;p=libvpx

Add comments to portion of SVC interface.

Fixes issue #705.

Change-Id: I60d45ee28fb34f401a440015bfe7bd3837b51de1
---

diff --git a/vpx/vp8cx.h b/vpx/vp8cx.h
index d0ac1afc8..f7dde6272 100644
--- a/vpx/vp8cx.h
+++ b/vpx/vp8cx.h
@@ -297,9 +297,16 @@ typedef struct vpx_svc_parameters {
   int alt_fb_idx;             /**< alt reference frame frame buffer index */
 } vpx_svc_parameters_t;
 
+/*!\brief  vp9 svc layer parameters
+ *
+ * This defines the spatial and temporal layer id numbers for svc encoding.
+ * This is used with the #VP9E_SET_SVC_LAYER_ID control to set the spatial and
+ * temporal layer id for the current frame.
+ *
+ */
 typedef struct vpx_svc_layer_id {
-  int spatial_layer_id;
-  int temporal_layer_id;
+  int spatial_layer_id;       /**< Spatial layer id number. */
+  int temporal_layer_id;      /**< Temporal layer id number. */
 } vpx_svc_layer_id_t;
 
 /*!\brief VP8 encoder control function parameter type