commit edf0f4a8e2638e9f9b2a0fe277d86dfd7e626124
author Paul Wilkins <paulwilkins@google.com> Tue Jul 21 16:47:52 2020 +0100
committer Paul Wilkins <paulwilkins@google.com> Wed Jul 22 11:22:12 2020 +0000
tree de162cb5f215f97867cfddbecac483df9492fe4a
parent 4dcbd921c3a686185c705eeccb154da52858d23b

Resolve frame buffer type reference.

Resolve a TODO reference to the YV12 frame buffer structure in the
encoder overview document.

Change-Id: I8d6dfcb33eee752db806ecaffb0676ce144c27c7

aom_scale/yv12config.h

diff --git a/aom_scale/yv12config.h b/aom_scale/yv12config.h
index b40edec..dfd4e51 100644
--- a/aom_scale/yv12config.h
+++ b/aom_scale/yv12config.h
@@ -23,6 +23,8 @@
 #include "aom/aom_integer.h"
 #include "aom/internal/aom_image_internal.h"
 
+/*!\cond */
+
 #define AOMINNERBORDERINPIXELS 160
 #define AOM_INTERP_EXTEND 4
 #define AOM_BORDER_IN_PIXELS 288
@@ -30,7 +32,12 @@
 #define AOM_ENC_TPL_FRAME_BORDER 32
 #define AOM_DEC_BORDER_IN_PIXELS 64
 
+/*!\endcond */
+/*!
+ * \brief YV12 frame buffer data structure
+ */
 typedef struct yv12_buffer_config {
+  /*!\cond */
   union {
     struct {
       int y_width;
@@ -107,8 +114,11 @@
   int corrupted;
   int flags;
   aom_metadata_array_t *metadata;
+  /*!\endcond */
 } YV12_BUFFER_CONFIG;
 
+/*!\cond */
+
 #define YV12_FLAG_HIGHBITDEPTH 8
 
 int aom_alloc_frame_buffer(YV12_BUFFER_CONFIG *ybf, int width, int height,
@@ -130,6 +140,7 @@
 
 int aom_free_frame_buffer(YV12_BUFFER_CONFIG *ybf);
 
+/*!\endcond */
 /*!\brief Removes metadata from YUV_BUFFER_CONFIG struct.
  *
  * Frees metadata in frame buffer.

doc/dev_guide/av1_encoder.dox

diff --git a/doc/dev_guide/av1_encoder.dox b/doc/dev_guide/av1_encoder.dox
index a5191d4..7570b06 100644
--- a/doc/dev_guide/av1_encoder.dox
+++ b/doc/dev_guide/av1_encoder.dox
@@ -104,7 +104,7 @@
 
 - \ref AV1_COMP
     - \ref AV1_COMP.oxcf (\ref AV1EncoderConfig)
-    - \ref AV1_COMP.alt_ref_buffer ((TODO REF) YV12_BUFFER_CONFIG)
+    - \ref AV1_COMP.alt_ref_buffer (\ref yv12_buffer_config)
     - \ref AV1_COMP.rc (\ref RATE_CONTROL)
     - \ref AV1_COMP.twopass (\ref TWO_PASS)
     - \ref AV1_COMP.gf_group (\ref GF_GROUP)
@@ -173,7 +173,7 @@
 
 - \ref AV1_COMP cpi (the main compressor instance data structure)
     - \ref AV1_COMP.oxcf (\ref AV1EncoderConfig)
-    - \ref AV1_COMP.alt_ref_buffer ((TODO REF) YV12_BUFFER_CONFIG)
+    - \ref AV1_COMP.alt_ref_buffer (\ref yv12_buffer_config)
 
 - \ref AV1EncoderConfig (Encoder configuration parameters)
     - \ref AV1EncoderConfig.algo_cfg (\ref AlgoCfg)

docs.cmake

diff --git a/docs.cmake b/docs.cmake
index 78fac5a..38e5f59 100644
--- a/docs.cmake
+++ b/docs.cmake
@@ -112,6 +112,7 @@
                           "${AOM_ROOT}/doc/dev_guide/av1_encoder.dox")
   set(AOM_DOXYGEN_SOURCES
       ${AOM_DOXYGEN_SOURCES}
+      "${AOM_ROOT}/aom_scale/yv12config.h"
       "${AOM_ROOT}/av1/encoder/bitstream.h"
       "${AOM_ROOT}/av1/encoder/block.h"
       "${AOM_ROOT}/av1/encoder/aq_cyclicrefresh.h"