commit 7de6531f816f7f6c0e20a618db68ef1588a667ac
author Sarah Parker <sarahparker@google.com> Mon Jun 15 13:39:34 2020 -0700
committer Sarah Parker <sarahparker@google.com> Tue Jun 16 00:52:28 2020 +0000
tree 1b2bb6d17672ac8391d6d8a05e6cede70351f1f9
parent 393387f6b6ee2aaa6aa84ff76a7519c3337f5ee2

Doxygen for motion_mode_candidate

BUG=aomedia:2700

Change-Id: I4e184e95d7229f0d738105ad8c6c28ff8fba18eb

av1/encoder/rdopt.c

diff --git a/av1/encoder/rdopt.c b/av1/encoder/rdopt.c
index 1da1652..fcadb1d 100644
--- a/av1/encoder/rdopt.c
+++ b/av1/encoder/rdopt.c
@@ -2064,15 +2064,37 @@
   return result;
 }
 
-/*!\cond */
+/*!\brief Motion mode information for inter mode search speedup.
+ *
+ * Used in a speed feature to search motion modes other than
+ * SIMPLE_TRANSLATION only on winning candidates.
+ */
 typedef struct motion_mode_candidate {
+  /*!
+   * Mode info for the motion mode candidate.
+   */
   MB_MODE_INFO mbmi;
+  /*!
+   * Rate describing the cost of the motion vectors for this candidate.
+   */
   int rate_mv;
+  /*!
+   * Rate before motion mode search and transform coding is applied.
+   */
   int rate2_nocoeff;
+  /*!
+   * An integer value 0 or 1 which indicates whether or not to skip the motion
+   * mode search and default to SIMPLE_TRANSLATION as a speed feature for this
+   * candidate.
+   */
   int skip_motion_mode;
+  /*!
+   * Total RD cost for this candidate.
+   */
   int64_t rd_cost;
 } motion_mode_candidate;
 
+/*!\cond */
 typedef struct motion_mode_best_st_candidate {
   motion_mode_candidate motion_mode_cand[MAX_WINNER_MOTION_MODES];
   int num_motion_mode_cand;