Fix doxygen warnings on \return with void function
Fix doxygen 1.9.4 warnings on \return with functions returning void. An
example is
aom/av1/encoder/speed_features.h:1696: warning: found documented
return type for av1_set_speed_features_framesize_independent that does
not return anything
If the text for \return simply says nothing is returned, then delete
\return. Otherwise, replace \return with \remark.
Bug: aomedia:3316
Change-Id: I4ece059888fa05c543d26cafa4a45f6f44f08149
diff --git a/av1/common/cdef.h b/av1/common/cdef.h
index 5bf40e4..e166f4b 100644
--- a/av1/common/cdef.h
+++ b/av1/common/cdef.h
@@ -89,7 +89,7 @@
* \param[in] xd Pointer to common current coding block structure
* \param[in] cdef_init_fb_row_fn Function Pointer
*
- * \return Nothing is returned. Instead, the filtered frame is output in
+ * \remark Nothing is returned. Instead, the filtered frame is output in
* \c frame.
*/
void av1_cdef_frame(YV12_BUFFER_CONFIG *frame, AV1_COMMON *const cm,
diff --git a/av1/common/restoration.h b/av1/common/restoration.h
index 65ccd09..a87b9ba 100644
--- a/av1/common/restoration.h
+++ b/av1/common/restoration.h
@@ -397,7 +397,7 @@
* should be at least SGRPROJ_TMPBUF_SIZE big.
* \param[in] optimized_lr Whether to use fast optimized Loop Restoration
*
- * \return Nothing is returned. Instead, the filtered unit is output in
+ * \remark Nothing is returned. Instead, the filtered unit is output in
* \c dst8 at the proper restoration unit offset.
*/
void av1_loop_restoration_filter_unit(
@@ -417,7 +417,7 @@
* \param[in] optimized_lr Whether to use fast optimized Loop Restoration
* \param[in] lr_ctxt Loop restoration context
*
- * \return Nothing is returned. Instead, the filtered frame is output in
+ * \remark Nothing is returned. Instead, the filtered frame is output in
* \c frame.
*/
void av1_loop_restoration_filter_frame(YV12_BUFFER_CONFIG *frame,
diff --git a/av1/encoder/aq_cyclicrefresh.h b/av1/encoder/aq_cyclicrefresh.h
index ecb5d6d..5c6aa34 100644
--- a/av1/encoder/aq_cyclicrefresh.h
+++ b/av1/encoder/aq_cyclicrefresh.h
@@ -172,7 +172,7 @@
* \param[in] mi_col Col coordinate of the block in a step size of MI_SIZE
* \param[in] bsize Block size
*
- * \return Update the \c mbmi->segment_id, the \c cpi->cyclic_refresh and
+ * \remark Update the \c mbmi->segment_id, the \c cpi->cyclic_refresh and
* the \c cm->cpi->enc_seg.map.
*/
@@ -201,7 +201,7 @@
* \param[in] dry_run A code indicating whether it is part of the final
* pass for reconstructing the superblock
*
- * \return Update the \c mbmi->segment_id, the \c cpi->cyclic_refresh and
+ * \remark Update the \c mbmi->segment_id, the \c cpi->cyclic_refresh and
* the \c cm->cpi->enc_seg.map.
*/
void av1_cyclic_refresh_update_segment(const struct AV1_COMP *cpi,
@@ -221,7 +221,7 @@
*
* \param[in] x Pointer to MACROBLOCK structure
*
- * \return Update the \c x->cnt_zeromv, the \c x->actual_num_seg1_blocks and
+ * \remark Update the \c x->cnt_zeromv, the \c x->actual_num_seg1_blocks and
* the \c x->actual_num_seg1_blocks.
*/
void av1_init_cyclic_refresh_counters(MACROBLOCK *const x);
@@ -238,7 +238,7 @@
* \param[in] cyclic_refresh Pointer to CYCLIC_REFRESH structure
* \param[in] x Pointer to MACROBLOCK structure
*
- * \return Update the \c cyclic_refresh->cnt_zeromv, the \c
+ * \remark Update the \c cyclic_refresh->cnt_zeromv, the \c
* cyclic_refresh->actual_num_seg1_blocks and the \c
* cyclic_refresh->actual_num_seg1_blocks.
*/
@@ -253,7 +253,7 @@
*
* \param[in] cpi Top level encoder structure
*
- * \return Returns the interval in \c cpi->rc.baseline_gf_interval.
+ * \remark Returns the interval in \c cpi->rc.baseline_gf_interval.
*/
void av1_cyclic_refresh_set_golden_update(struct AV1_COMP *const cpi);
@@ -270,7 +270,7 @@
*
* \param[in] cpi Top level encoder structure
*
- * \return Updates the \c cpi->cyclic_refresh with the settings.
+ * \remark Updates the \c cpi->cyclic_refresh with the settings.
*/
void av1_cyclic_refresh_update_parameters(struct AV1_COMP *const cpi);
@@ -284,7 +284,7 @@
*
* \param[in] cpi Top level encoder structure
*
- * \return Updates the \c cpi->cyclic_refresh with the cyclic refresh
+ * \remark Updates the \c cpi->cyclic_refresh with the cyclic refresh
* parameters and the \c cm->seg with the segmentation data.
*/
void av1_cyclic_refresh_setup(struct AV1_COMP *const cpi);
diff --git a/av1/encoder/encodeframe.c b/av1/encoder/encodeframe.c
index 1a28285..ed277b2 100644
--- a/av1/encoder/encodeframe.c
+++ b/av1/encoder/encodeframe.c
@@ -224,7 +224,7 @@
* \param[in] mi_col Block column (in "MI_SIZE" units) index
* \param[out] num_planes Number of image planes (e.g. Y,U,V)
*
- * \return No return value but updates macroblock and thread data
+ * \remark No return value but updates macroblock and thread data
* related to the q / q delta to be used.
*/
static AOM_INLINE void setup_delta_q(AV1_COMP *const cpi, ThreadData *td,
diff --git a/av1/encoder/firstpass.h b/av1/encoder/firstpass.h
index ca4401b..be52e8e 100644
--- a/av1/encoder/firstpass.h
+++ b/av1/encoder/firstpass.h
@@ -578,7 +578,7 @@
* \param[in] cpi Top-level encoder structure
* \param[in] ts_duration Duration of the frame / collection of frames
*
- * \return Nothing is returned. Instead, the "TWO_PASS" structure inside "cpi"
+ * \remark Nothing is returned. Instead, the "TWO_PASS" structure inside "cpi"
* is modified to store information computed in this function.
*/
void av1_first_pass(struct AV1_COMP *cpi, const int64_t ts_duration);
diff --git a/av1/encoder/gop_structure.h b/av1/encoder/gop_structure.h
index eb20c84..ff22f54 100644
--- a/av1/encoder/gop_structure.h
+++ b/av1/encoder/gop_structure.h
@@ -38,7 +38,7 @@
*
* \param[in] cpi Top - level encoder instance structure
*
- * \return No return value but this function updates group data structures.
+ * \remark No return value but this function updates group data structures.
*/
void av1_gop_setup_structure(struct AV1_COMP *cpi);
@@ -58,7 +58,7 @@
* uni-directional group.
* \param[in] gf_group_bits Bits available to be allocated.
*
- * \return No return but updates the rate control and group data structures
+ * \remark No return but updates the rate control and group data structures
* to reflect the allocation of bits.
*/
void av1_gop_bit_allocation(const AV1_COMP *cpi, RATE_CONTROL *const rc,
diff --git a/av1/encoder/intra_mode_search.c b/av1/encoder/intra_mode_search.c
index ab8e3c3..113144c 100644
--- a/av1/encoder/intra_mode_search.c
+++ b/av1/encoder/intra_mode_search.c
@@ -1179,7 +1179,7 @@
* \callergraph
* This function loops through all filter_intra modes to find the best one.
*
- * \return Returns nothing, but updates the mbmi and rd_stats.
+ * \remark Returns nothing, but updates the mbmi and rd_stats.
*/
static INLINE void handle_filter_intra_mode(const AV1_COMP *cpi, MACROBLOCK *x,
BLOCK_SIZE bsize,
diff --git a/av1/encoder/intra_mode_search.h b/av1/encoder/intra_mode_search.h
index 0a6b769..7ee61d7 100644
--- a/av1/encoder/intra_mode_search.h
+++ b/av1/encoder/intra_mode_search.h
@@ -196,8 +196,6 @@
* \param[in] this_rd_cost Struct to keep track of palette mode's
* rd_stats.
* \param[in] best_rd Best RD seen for this block so far.
- *
- * \return Returns nothing.
*/
void av1_search_palette_mode_luma(const AV1_COMP *cpi, MACROBLOCK *x,
BLOCK_SIZE bsize, unsigned int ref_frame_cost,
diff --git a/av1/encoder/nonrd_opt.h b/av1/encoder/nonrd_opt.h
index 39049e5..d80e48d 100644
--- a/av1/encoder/nonrd_opt.h
+++ b/av1/encoder/nonrd_opt.h
@@ -37,7 +37,7 @@
* prune for low temporal variance block
* \param[in] skip_pred_mv Flag indicating to skip av1_mv_pred
*
- * \return Nothing is returned. Instead, predicted MVs are placed into
+ * \remark Nothing is returned. Instead, predicted MVs are placed into
* \c frame_mv array
*/
static INLINE void find_predictors(
diff --git a/av1/encoder/nonrd_pickmode.c b/av1/encoder/nonrd_pickmode.c
index d2c81df..74450d8 100644
--- a/av1/encoder/nonrd_pickmode.c
+++ b/av1/encoder/nonrd_pickmode.c
@@ -932,7 +932,7 @@
* \param[in] tx_type Transform kernel type
* \param[in] is_inter_mode Flag to indicate inter mode
*
- * \return Nothing is returned. Instead, calculated RD cost is placed to
+ * \remark Nothing is returned. Instead, calculated RD cost is placed to
* \c this_rdc. \c skippable flag is set if there is no non-zero quantized
* coefficients for Hadamard transform
*/
@@ -1440,7 +1440,7 @@
* \param[in] arg Pointer to a structure that holds paramaters
* for intra mode search
*
- * \return Nothing is returned. Instead, best mode and RD Cost of the best mode
+ * \remark Nothing is returned. Instead, best mode and RD Cost of the best mode
* are set in \c args->rdc and \c args->mode
*/
static void estimate_block_intra(int plane, int block, int row, int col,
@@ -1623,7 +1623,7 @@
* large blocks
* \param[in] best_sse Best sse so far.
*
- * \return Nothing is returned. Instead, calculated RD cost is placed to
+ * \remark Nothing is returned. Instead, calculated RD cost is placed to
* \c this_rdc and best filter is placed to \c mi->interp_filters. In case
* \c reuse_inter_pred flag is set, this function also ouputs
* \c this_mode_pred. Also \c this_early_temp is set if transform can be
@@ -2159,7 +2159,7 @@
* \param[in] ctx Pointer to structure holding coding
* contexts and modes for the block
*
- * \return Nothing is returned. Instead, calculated RD cost is placed to
+ * \remark Nothing is returned. Instead, calculated RD cost is placed to
* \c best_rdc and best selected mode is placed to \c best_pickmode
*/
static void estimate_intra_mode(
diff --git a/av1/encoder/palette.h b/av1/encoder/palette.h
index 7d9a72f..9d4cb22 100644
--- a/av1/encoder/palette.h
+++ b/av1/encoder/palette.h
@@ -49,7 +49,7 @@
* \param[in] k Number of clusters.
* \param[in] dim Data dimension.
*
- * \return Returns nothing, but saves each data's cluster index in indices.
+ * \remark Returns nothing, but saves each data's cluster index in indices.
*/
static INLINE void av1_calc_indices(const int *data, const int *centroids,
uint8_t *indices, int n, int k, int dim) {
@@ -79,7 +79,7 @@
* \param[in] dim Data dimension.
* \param[in] max_itr Maximum number of iterations to run.
*
- * \return Returns nothing, but saves each cluster's centroid in centroids and
+ * \remark Returns nothing, but saves each cluster's centroid in centroids and
* each data's cluster index in indices.
*
* \attention The output centroids are rounded off to nearest integers.
diff --git a/av1/encoder/partition_search.c b/av1/encoder/partition_search.c
index 985b296..9a7aee3 100644
--- a/av1/encoder/partition_search.c
+++ b/av1/encoder/partition_search.c
@@ -724,7 +724,7 @@
* \param[in] ctx Structure to hold snapshot of coding context
during the mode picking process
*
- * \return Nothing is returned. Instead, the MB_MODE_INFO struct inside x
+ * \remark Nothing is returned. Instead, the MB_MODE_INFO struct inside x
* is modified to store information about the best mode computed
* in this function. The rd_cost struct is also updated with the RD stats
* corresponding to the best mode found.
@@ -888,7 +888,7 @@
* chosen modes for the current block
* \param[in] best_rd Upper bound of rd cost of a valid partition
*
- * \return Nothing is returned. Instead, the chosen modes and contexts necessary
+ * \remark Nothing is returned. Instead, the chosen modes and contexts necessary
* for reconstruction are stored in ctx, the rate-distortion stats are stored in
* rd_cost. If no valid mode leading to rd_cost <= best_rd, the status will be
* signalled by an INT64_MAX rd_cost->rdcost.
@@ -1468,7 +1468,7 @@
* chosen modes for the current block
* \param[in] rate Pointer to the total rate for the current block
*
- * \return Nothing is returned. Instead, reconstructions (w/o in-loop filters)
+ * \remark Nothing is returned. Instead, reconstructions (w/o in-loop filters)
* will be updated in the pixel buffers in td->mb.e_mbd. Also, the chosen modes
* will be stored in the MB_MODE_INFO buffer td->mb.e_mbd.mi[0].
*/
@@ -1631,7 +1631,7 @@
* partitions and mode info for the current block
* \param[in] rate Pointer to the total rate for the current block
*
- * \return Nothing is returned. Instead, reconstructions (w/o in-loop filters)
+ * \remark Nothing is returned. Instead, reconstructions (w/o in-loop filters)
* will be updated in the pixel buffers in td->mb.e_mbd.
*/
static void encode_sb(const AV1_COMP *const cpi, ThreadData *td,
@@ -1813,7 +1813,7 @@
* \param[in] pc_tree Pointer to the PC_TREE node holding the picked
partitions and mode info for the current block
*
-* \return Nothing is returned. The pc_tree struct is modified to store the
+* \remark Nothing is returned. The pc_tree struct is modified to store the
* picked partition and modes. The rate and dist are also updated with those
* corresponding to the best partition found.
*/
@@ -2250,7 +2250,7 @@
* \param[in] ctx Pointer to structure holding coding contexts and
* chosen modes for the current block
*
- * \return Nothing is returned. Instead, the chosen modes and contexts necessary
+ * \remark Nothing is returned. Instead, the chosen modes and contexts necessary
* for reconstruction are stored in ctx, the rate-distortion stats are stored in
* rd_cost. If no valid mode leading to rd_cost <= best_rd, the status will be
* signalled by an INT64_MAX rd_cost->rdcost.
@@ -2593,7 +2593,7 @@
* \param[in] pc_tree Pointer to the PC_TREE node holding the picked
partitions and mode info for the current block
*
-* \return Nothing is returned. The pc_tree struct is modified to store the
+* \remark Nothing is returned. The pc_tree struct is modified to store the
* picked partition and modes.
*/
void av1_nonrd_use_partition(AV1_COMP *cpi, ThreadData *td,
diff --git a/av1/encoder/pass2_strategy.c b/av1/encoder/pass2_strategy.c
index 0dd0939..2716efb 100644
--- a/av1/encoder/pass2_strategy.c
+++ b/av1/encoder/pass2_strategy.c
@@ -1876,7 +1876,7 @@
* \param[in] max_gop_length Maximum length of the GF group
* \param[in] max_intervals Maximum number of intervals to decide
*
- * \return Nothing is returned. Instead, cpi->ppi->rc.gf_intervals is
+ * \remark Nothing is returned. Instead, cpi->ppi->rc.gf_intervals is
* changed to store the decided GF group lengths.
*/
static void calculate_gf_length(AV1_COMP *cpi, int max_gop_length,
@@ -2143,7 +2143,7 @@
*
* \param[in] cpi Top-level encoder structure
*
- * \return Nothing is returned. Instead, cpi->ppi->gf_group is changed.
+ * \remark Nothing is returned. Instead, cpi->ppi->gf_group is changed.
*/
static void define_gf_group_pass0(AV1_COMP *cpi) {
RATE_CONTROL *const rc = &cpi->rc;
@@ -2432,7 +2432,7 @@
* \param[in] is_final_pass Whether this is the final pass for the
* GF group, or a trial (non-zero)
*
- * \return Nothing is returned. Instead, cpi->ppi->gf_group is changed.
+ * \remark Nothing is returned. Instead, cpi->ppi->gf_group is changed.
*/
static void define_gf_group(AV1_COMP *cpi, EncodeFrameParams *frame_params,
int is_final_pass) {
@@ -3147,8 +3147,6 @@
*
* \param[in] cpi Top-level encoder structure
* \param[in] this_frame Pointer to first pass stats
- *
- * \return Nothing is returned.
*/
static void find_next_key_frame(AV1_COMP *cpi, FIRSTPASS_STATS *this_frame) {
RATE_CONTROL *const rc = &cpi->rc;
diff --git a/av1/encoder/pass2_strategy.h b/av1/encoder/pass2_strategy.h
index 8bcc8b8..87e08bb 100644
--- a/av1/encoder/pass2_strategy.h
+++ b/av1/encoder/pass2_strategy.h
@@ -82,7 +82,7 @@
* \param[in] frame_params Per frame encoding parameters
* \param[in] frame_flags Frame type and coding flags
*
- * \return No return but analyses first pass stats and assigns a target
+ * \remark No return but analyses first pass stats and assigns a target
* number of bits to the current frame and a target Q range.
*/
void av1_get_second_pass_params(struct AV1_COMP *cpi,
@@ -98,7 +98,7 @@
*
* \param[in] cpi Top - level encoder instance structure
*
- * \return No return value but this function updates various rate control
+ * \remark No return value but this function updates various rate control
* related data structures that for example track overshoot and
* undershoot.
*/
@@ -120,7 +120,7 @@
* uni-directional group.
* \param[in] gf_group_bits Bits available to be allocated.
*
- * \return No return but updates the rate control and group data structures
+ * \remark No return but updates the rate control and group data structures
* to reflect the allocation of bits.
*/
void av1_gop_bit_allocation(const AV1_COMP *cpi, RATE_CONTROL *const rc,
diff --git a/av1/encoder/pickcdef.h b/av1/encoder/pickcdef.h
index 278de38..077edcb 100644
--- a/av1/encoder/pickcdef.h
+++ b/av1/encoder/pickcdef.h
@@ -231,7 +231,7 @@
* \param[in] non_reference_frame Indicates if current frame is
* non-reference
*
- * \return Nothing is returned. Instead, optimal CDEF parameters are stored
+ * \remark Nothing is returned. Instead, optimal CDEF parameters are stored
* in the \c cdef_info structure of type \ref CdefInfo inside \c cm:
* \arg \c cdef_bits: Bits of strength parameters
* \arg \c nb_cdef_strengths: Number of strength parameters
diff --git a/av1/encoder/picklpf.h b/av1/encoder/picklpf.h
index 7273355..f567937 100644
--- a/av1/encoder/picklpf.h
+++ b/av1/encoder/picklpf.h
@@ -43,7 +43,7 @@
* \arg \c LPF_PICK_MINIMAL_LPF: Pick 0 to disable LPF if LPF was enabled last
* frame
*
- * \return Nothing is returned. Instead, filter levels below are stored in the
+ * \remark Nothing is returned. Instead, filter levels below are stored in the
* "loopfilter" structure inside "cpi":
* \arg \c filter_level[0]: the vertical filter level for Y plane
* \arg \c filter_level[1]: the horizontal filter level for Y plane
diff --git a/av1/encoder/pickrst.h b/av1/encoder/pickrst.h
index 46a4b48..94a6932 100644
--- a/av1/encoder/pickrst.h
+++ b/av1/encoder/pickrst.h
@@ -65,7 +65,7 @@
* \param[in] sd Source frame buffer
* \param[in,out] cpi Top-level encoder structure
*
- * \return Nothing is returned. Instead, chosen restoration filter
+ * \remark Nothing is returned. Instead, chosen restoration filter
* types and parameters are stored per plane in the \c rst_info structure
* of type \ref RestorationInfo inside \c cpi->common:
* \arg \c rst_info[ \c 0 ]: Chosen parameters for Y plane
diff --git a/av1/encoder/ratectrl.c b/av1/encoder/ratectrl.c
index ca1f9a0..f520d0b 100644
--- a/av1/encoder/ratectrl.c
+++ b/av1/encoder/ratectrl.c
@@ -606,7 +606,7 @@
* \param[in] width Frame width
* \param[in] height Frame height
*
- * \return None but updates the rate correction factor for the
+ * \remark Updates the rate correction factor for the
* current frame type in cpi->rc.
*/
static void set_rate_correction_factor(AV1_COMP *cpi, int is_encode_stage,
@@ -2587,7 +2587,7 @@
* \param[in] cpi Top level encoder structure
* \param[in] gf_update Flag to indicate if GF is updated
*
- * \return Nothing is returned. Instead the settings for the prediction
+ * \remark Nothing is returned. Instead the settings for the prediction
* structure are set in \c cpi-ext_flags; and the buffer slot index
* (for each of 7 references) and refresh flags (for each of the 8 slots)
* are set in \c cpi->svc.ref_idx[] and \c cpi->svc.refresh[].
@@ -2690,7 +2690,7 @@
* \param[in] cpi Top level encoder structure
* \param[in] frame_input Current and last input source frames
*
- * \return Nothing is returned. Instead the flag \c cpi->rc.high_source_sad
+ * \remark Nothing is returned. Instead the flag \c cpi->rc.high_source_sad
* is set if scene change is detected, and \c cpi->rc.avg_source_sad is updated.
*/
static void rc_scene_detection_onepass_rt(AV1_COMP *cpi,
@@ -2917,7 +2917,7 @@
* \ingroup rate_control
* \param[in] cpi Top level encoder structure
*
- * \return Return resized width/height in \c cpi->resize_pending_params,
+ * \remark Return resized width/height in \c cpi->resize_pending_params,
* and update some resize counters in \c rc.
*/
static void dynamic_resize_one_pass_cbr(AV1_COMP *cpi) {
diff --git a/av1/encoder/ratectrl.h b/av1/encoder/ratectrl.h
index d5df59b..4e2ba6a 100644
--- a/av1/encoder/ratectrl.h
+++ b/av1/encoder/ratectrl.h
@@ -605,7 +605,7 @@
* \param[in] width Frame width
* \param[in] height Frame height
*
- * \return None but updates the relevant rate correction factor in cpi->rc
+ * \remark Updates the relevant rate correction factor in cpi->rc
*/
void av1_rc_update_rate_correction_factors(struct AV1_COMP *cpi,
int is_encode_stage, int width,
@@ -772,7 +772,7 @@
* \param[in] frame_input Current and last input source frames
* \param[in] frame_flags Emcoder frame flags
*
- * \return Nothing is returned. Instead the settings computed in this
+ * \remark Nothing is returned. Instead the settings computed in this
* funtion are set in: \c frame_params, \c cpi->common, \c cpi->rc, \c cpi->svc.
*/
void av1_get_one_pass_rt_params(struct AV1_COMP *cpi,
diff --git a/av1/encoder/rdopt.h b/av1/encoder/rdopt.h
index 2fead8f..4d813a2 100644
--- a/av1/encoder/rdopt.h
+++ b/av1/encoder/rdopt.h
@@ -54,7 +54,7 @@
during the mode picking process.
* \param[in] best_rd Best RD seen for this block so far.
*
- * \return Nothing is returned. Instead, the MB_MODE_INFO struct inside x
+ * \remark Nothing is returned. Instead, the MB_MODE_INFO struct inside x
* is modified to store information about the best mode computed
* in this function. The rd_cost struct is also updated with the RD stats
* corresponding to the best mode found.
@@ -85,7 +85,7 @@
during the mode picking process
* \param[in] best_rd_so_far Best RD seen for this block so far
*
- * \return Nothing is returned. Instead, the MB_MODE_INFO struct inside x
+ * \remark Nothing is returned. Instead, the MB_MODE_INFO struct inside x
* is modified to store information about the best mode computed
* in this function. The rd_cost struct is also updated with the RD stats
* corresponding to the best mode found.
@@ -115,7 +115,7 @@
* \param[in] ctx Structure to hold snapshot of coding context
during the mode picking process
*
- * \return Nothing is returned. Instead, the MB_MODE_INFO struct inside x
+ * \remark Nothing is returned. Instead, the MB_MODE_INFO struct inside x
* is modified to store information about the best mode computed
* in this function. The rd_cost struct is also updated with the RD stats
* corresponding to the best mode found.
@@ -147,7 +147,7 @@
* \param[in] ctx Structure to hold snapshot of coding context
during the mode picking process
*
- * \return Nothing is returned. Instead, the MB_MODE_INFO struct inside x
+ * \remark Nothing is returned. Instead, the MB_MODE_INFO struct inside x
* is modified to store information about the best mode computed
* in this function. The rd_cost struct is also updated with the RD stats
* corresponding to the best mode found.
diff --git a/av1/encoder/speed_features.h b/av1/encoder/speed_features.h
index 2396ca2..62d248a 100644
--- a/av1/encoder/speed_features.h
+++ b/av1/encoder/speed_features.h
@@ -1696,7 +1696,7 @@
* \param[in] cpi Top - level encoder instance structure
* \param[in] speed Speed setting passed in from the command line
*
- * \return No return value but configures the various speed trade off flags
+ * \remark No return value but configures the various speed trade off flags
* based on the passed in speed setting. (Higher speed gives lower
* quality)
*/
@@ -1710,7 +1710,7 @@
* \param[in] cpi Top - level encoder instance structure
* \param[in] speed Speed setting passed in from the command line
*
- * \return No return value but configures the various speed trade off flags
+ * \remark No return value but configures the various speed trade off flags
* based on the passed in speed setting and frame size. (Higher speed
* corresponds to lower quality)
*/
@@ -1723,7 +1723,7 @@
* \param[in] cpi Top - level encoder instance structure
* \param[in] speed Speed setting passed in from the command line
*
- * \return No return value but configures the various speed trade off flags
+ * \remark No return value but configures the various speed trade off flags
* based on the passed in speed setting and current frame's Q index.
* (Higher speed corresponds to lower quality)
*/
diff --git a/av1/encoder/svc_layercontext.h b/av1/encoder/svc_layercontext.h
index e3c2653..da8cd3e 100644
--- a/av1/encoder/svc_layercontext.h
+++ b/av1/encoder/svc_layercontext.h
@@ -152,7 +152,7 @@
*
* \param[in] cpi Top level encoder structure
*
- * \return Nothing returned. Set cpi->svc.
+ * \remark Nothing returned. Set cpi->svc.
*/
void av1_init_layer_context(struct AV1_COMP *const cpi);
@@ -165,7 +165,7 @@
* \param[in] cpi Top level encoder structure
* \param[in] target_bandwidth Total target bandwidth
*
- * \return Nothing returned. Buffer level for each layer is set.
+ * \remark Nothing returned. Buffer level for each layer is set.
*/
void av1_update_layer_context_change_config(struct AV1_COMP *const cpi,
const int64_t target_bandwidth);
@@ -179,7 +179,7 @@
*
* \param[in] cpi Top level encoder structure
*
- * \return Nothing returned. Frame related quantities for current temporal
+ * \remark Nothing returned. Frame related quantities for current temporal
layer are updated.
*/
void av1_update_temporal_layer_framerate(struct AV1_COMP *const cpi);
@@ -193,7 +193,7 @@
*
* \param[in] cpi Top level encoder structure
*
- * \return Nothing returned. Layer context for current layer is set.
+ * \remark Nothing returned. Layer context for current layer is set.
*/
void av1_restore_layer_context(struct AV1_COMP *const cpi);
@@ -204,8 +204,6 @@
* \callergraph
*
* \param[in] cpi Top level encoder structure
- *
- * \return Nothing returned.
*/
void av1_save_layer_context(struct AV1_COMP *const cpi);
@@ -216,8 +214,6 @@
* \callergraph
*
* \param[in] cpi Top level encoder structure
- *
- * \return Nothing returned.
*/
void av1_free_svc_cyclic_refresh(struct AV1_COMP *const cpi);
@@ -229,8 +225,6 @@
*
* \param[in] cpi Top level encoder structure
* \param[in] is_key Whether current layer is key frame
- *
- * \return Nothing returned.
*/
void av1_svc_reset_temporal_layers(struct AV1_COMP *const cpi, int is_key);
@@ -241,8 +235,6 @@
* \callergraph
*
* \param[in] cpi Top level encoder structure
- *
- * \return Nothing returned.
*/
void av1_one_pass_cbr_svc_start_layer(struct AV1_COMP *const cpi);
@@ -268,7 +260,7 @@
* \param[in] width_out Output width, scaled for current layer
* \param[in] height_out Output height, scaled for current layer
*
- * \return Nothing is returned. Instead the scaled width and height are set.
+ * \remark Nothing is returned. Instead the scaled width and height are set.
*/
void av1_get_layer_resolution(const int width_org, const int height_org,
const int num, const int den, int *width_out,
diff --git a/av1/encoder/temporal_filter.c b/av1/encoder/temporal_filter.c
index cc7b49f..6f8b08c3 100644
--- a/av1/encoder/temporal_filter.c
+++ b/av1/encoder/temporal_filter.c
@@ -81,7 +81,7 @@
* \param[out] subblock_mses Pointer to the search errors (MSE) for 4
* sub-blocks
*
- * \return Nothing will be returned. Results are saved in subblock_mvs and
+ * \remark Nothing will be returned. Results are saved in subblock_mvs and
* subblock_mses
*/
static void tf_motion_search(AV1_COMP *cpi, MACROBLOCK *mb,
@@ -323,7 +323,7 @@
* order)
* \param[out] pred Pointer to the predictor to be built
*
- * \return Nothing returned, But the contents of `pred` will be modified
+ * \remark Nothing returned, But the contents of `pred` will be modified
*/
static void tf_build_predictor(const YV12_BUFFER_CONFIG *ref_frame,
const MACROBLOCKD *mbd,
@@ -551,7 +551,7 @@
* \param[out] count Pointer to the pixel-wise counter for
* filtering
*
- * \return Nothing returned, But the contents of `accum`, `pred` and 'count'
+ * \remark Nothing returned, But the contents of `accum`, `pred` and 'count'
* will be modified
*/
void av1_apply_temporal_filter_c(
@@ -734,7 +734,7 @@
* \param[in] count Pointer to the pre-computed count
* \param[out] result_buffer Pointer to result buffer
*
- * \return Nothing returned, but the content to which `result_buffer` pointer
+ * \remark Nothing returned, but the content to which `result_buffer` pointer
* will be modified
*/
static void tf_normalize_filtered_frame(
@@ -914,7 +914,7 @@
* \ingroup src_frame_proc
* \param[in] cpi Top level encoder instance structure
*
- * \return Nothing will be returned, but the contents of td->diff will be
+ * \remark Nothing will be returned, but the contents of td->diff will be
modified.
*/
static void tf_do_filtering(AV1_COMP *cpi) {
@@ -949,7 +949,7 @@
* in the lookahead buffer cpi->lookahead
* \param[in] gf_frame_index GOP index
*
- * \return Nothing will be returned. But the fields `frames`, `num_frames`,
+ * \remark Nothing will be returned. But the fields `frames`, `num_frames`,
* `filter_frame_idx` and `noise_levels` will be updated in cpi->tf_ctx.
*/
static void tf_setup_filtering_buffer(AV1_COMP *cpi,
diff --git a/av1/encoder/temporal_filter.h b/av1/encoder/temporal_filter.h
index 633dbe4..725bd86 100644
--- a/av1/encoder/temporal_filter.h
+++ b/av1/encoder/temporal_filter.h
@@ -287,7 +287,7 @@
* \param[in] mb_row Macroblock row to be filtered
filtering
*
-* \return Nothing will be returned, but the contents of td->diff will be
+* \remark Nothing will be returned, but the contents of td->diff will be
modified.
*/
void av1_tf_do_filtering_row(struct AV1_COMP *cpi, struct ThreadData *td,
diff --git a/av1/encoder/tx_search.h b/av1/encoder/tx_search.h
index e3caf5b..b3689cf 100644
--- a/av1/encoder/tx_search.h
+++ b/av1/encoder/tx_search.h
@@ -89,7 +89,7 @@
* \param[in] rd_stats Pointer to struct to keep track of the RD stats
* \param[in] bsize Current macroblock size
* \param[in] ref_best_rd Best RD cost seen for this block so far
- * \return Nothing is returned. The selected transform size and type will
+ * \remark Nothing is returned. The selected transform size and type will
be saved in the MB_MODE_INFO structure
*/
void av1_pick_recursive_tx_size_type_yrd(const AV1_COMP *cpi, MACROBLOCK *x,
@@ -111,7 +111,7 @@
* \param[in] rd_stats Pointer to struct to keep track of the RD stats
* \param[in] bs Current macroblock size
* \param[in] ref_best_rd Best RD cost seen for this block so far
- * \return Nothing is returned. The selected transform size and type will
+ * \remark Nothing is returned. The selected transform size and type will
be saved in the MB_MODE_INFO structure
*/
void av1_pick_uniform_tx_size_type_yrd(const AV1_COMP *const cpi, MACROBLOCK *x,
@@ -158,7 +158,7 @@
* \param[in] skip_trellis Binary flag indicating if trellis optimization
should be skipped
*
- * \return Nothing is returned. The RD results will be saved in rd_stats.
+ * \remark Nothing is returned. The RD results will be saved in rd_stats.
*/
void av1_txfm_rd_in_plane(MACROBLOCK *x, const AV1_COMP *cpi,
RD_STATS *rd_stats, int64_t ref_best_rd,
diff --git a/av1/encoder/var_based_part.h b/av1/encoder/var_based_part.h
index 5176751..0136268 100644
--- a/av1/encoder/var_based_part.h
+++ b/av1/encoder/var_based_part.h
@@ -44,7 +44,7 @@
* \param[in] q q index
* \param[in] content_lowsumdiff Low sumdiff flag for superblock
*
- * \return Returns the set of thresholds in \c cpi->vbp_info.thresholds.
+ * \remark Returns the set of thresholds in \c cpi->vbp_info.thresholds.
*/
void av1_set_variance_partition_thresholds(AV1_COMP *cpi, int q,
int content_lowsumdiff);
