From f58eca90200c4388cc2c3a2149ce472f9aa4c5ff Mon Sep 17 00:00:00 2001
From: Adrian Grange <agrange@google.com>
Date: Thu, 24 Oct 2013 15:11:36 -0700
Subject: [PATCH] Resolved Doxygen warnings.
Added comments to make the codebase build cleanly in Doxygen.
Change-Id: I01e000ceac57dbafa04342858c8f1be250ba20d1
---
vpx/vp8.h | 9 +++++----
vpx/vp8cx.h | 20 ++++++++++----------
vpx/vp8dx.h | 8 +++++++-
vpx/vpx_codec.h | 10 +++++-----
vpx/vpx_decoder.h | 10 ++++------
vpx/vpx_encoder.h | 9 ++++-----
6 files changed, 35 insertions(+), 31 deletions(-)
diff --git a/vpx/vp8.h b/vpx/vp8.h
index 57d3cae26b..056fa7aed7 100644
--- a/vpx/vp8.h
+++ b/vpx/vp8.h
@@ -100,14 +100,17 @@ typedef enum vpx_ref_frame_type {
/*!\brief reference frame data struct
*
- * define the data struct to access vp8 reference frames
+ * Define the data struct to access vp8 reference frames.
*/
-
typedef struct vpx_ref_frame {
vpx_ref_frame_type_t frame_type; /**< which reference frame */
vpx_image_t img; /**< reference frame data in image format */
} vpx_ref_frame_t;
+/*!\brief VP9 specific reference frame data struct
+ *
+ * Define the data struct to access vp9 reference frames.
+ */
typedef struct vp9_ref_frame {
int idx; /**< frame index to get (input) */
vpx_image_t img; /**< img structure to populate (output) */
@@ -117,7 +120,6 @@ typedef struct vp9_ref_frame {
*
* defines the data type for each of VP8 decoder control function requires
*/
-
VPX_CTRL_USE_TYPE(VP8_SET_REFERENCE, vpx_ref_frame_t *)
VPX_CTRL_USE_TYPE(VP8_COPY_REFERENCE, vpx_ref_frame_t *)
VPX_CTRL_USE_TYPE(VP8_SET_POSTPROC, vp8_postproc_cfg_t *)
@@ -127,7 +129,6 @@ VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_B_MODES, int)
VPX_CTRL_USE_TYPE(VP8_SET_DBG_DISPLAY_MV, int)
VPX_CTRL_USE_TYPE(VP9_GET_REFERENCE, vp9_ref_frame_t *)
-
/*! @} - end defgroup vp8 */
#ifdef __cplusplus
diff --git a/vpx/vp8cx.h b/vpx/vp8cx.h
index 92fdb004ba..9f68c38d2b 100644
--- a/vpx/vp8cx.h
+++ b/vpx/vp8cx.h
@@ -7,7 +7,8 @@
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
-
+#ifndef VP8CX_H
+#define VP8CX_H
/*!\defgroup vp8_encoder WebM VP8 Encoder
* \ingroup vp8
@@ -20,8 +21,6 @@
* \brief Provides definitions for using the VP8 encoder algorithm within the
* vpx Codec Interface.
*/
-#ifndef VP8CX_H
-#define VP8CX_H
#ifdef __cplusplus
extern "C" {
@@ -223,16 +222,17 @@ typedef enum vpx_scaling_mode_1d {
*/
typedef struct vpx_roi_map {
- unsigned char *roi_map; /**< specify an id between 0 and 3 for each 16x16 region within a frame */
- unsigned int rows; /**< number of rows */
- unsigned int cols; /**< number of cols */
+ /*! An id between 0 and 3 for each 16x16 region within a frame. */
+ unsigned char *roi_map;
+ unsigned int rows; /**< Number of rows. */
+ unsigned int cols; /**< Number of columns. */
// TODO(paulwilkins): broken for VP9 which has 8 segments
// q and loop filter deltas for each segment
// (see MAX_MB_SEGMENTS)
- int delta_q[4];
- int delta_lf[4];
- // Static breakout threshold for each segment
- unsigned int static_threshold[4];
+ int delta_q[4]; /**< Quantizer deltas. */
+ int delta_lf[4]; /**< Loop filter deltas. */
+ /*! Static breakout threshold for each segment. */
+ unsigned int static_threshold[4];
} vpx_roi_map_t;
/*!\brief vpx active region map
diff --git a/vpx/vp8dx.h b/vpx/vp8dx.h
index 50a223f2ad..d3093c48c5 100644
--- a/vpx/vp8dx.h
+++ b/vpx/vp8dx.h
@@ -45,7 +45,8 @@ extern vpx_codec_iface_t *vpx_codec_vp9_dx(void);
#include "vp8.h"
-/*!\brief VP8 decoder control functions
+/*!\enum vp8_dec_control_id
+ * \brief VP8 decoder control functions
*
* This set of macros define the control functions available for the VP8
* decoder interface.
@@ -78,12 +79,17 @@ enum vp8_dec_control_id {
VP8_DECODER_CTRL_ID_MAX
};
+/*!\brief Structure to hold decryption state
+ *
+ * Defines a structure to hold the decryption state and access function.
+ */
typedef struct vp8_decrypt_init {
/** Decrypt n bytes of data from input -> output, using the decrypt_state
* passed in VP8D_SET_DECRYPTOR.
*/
void (*decrypt_cb)(void *decrypt_state, const unsigned char *input,
unsigned char *output, int count);
+ /*! Decryption state. */
void *decrypt_state;
} vp8_decrypt_init;
diff --git a/vpx/vpx_codec.h b/vpx/vpx_codec.h
index 2e6f1e757a..3ea36d6ef1 100644
--- a/vpx/vpx_codec.h
+++ b/vpx/vpx_codec.h
@@ -36,12 +36,13 @@
* Once initialized, the instance is manged using other functions from
* the vpx_codec_* family.
*/
+#ifndef VPX_CODEC_H
+#define VPX_CODEC_H
+
#ifdef __cplusplus
extern "C" {
#endif
-#ifndef VPX_CODEC_H
-#define VPX_CODEC_H
#include "vpx_integer.h"
#include "vpx_image.h"
@@ -550,9 +551,8 @@ extern "C" {
/*!@} - end defgroup cap_xma*/
/*!@} - end defgroup codec*/
-
-
-#endif
#ifdef __cplusplus
}
#endif
+#endif
+
diff --git a/vpx/vpx_decoder.h b/vpx/vpx_decoder.h
index e7701e5123..2dcd024ccc 100644
--- a/vpx/vpx_decoder.h
+++ b/vpx/vpx_decoder.h
@@ -7,7 +7,8 @@
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
-
+#ifndef VPX_DECODER_H
+#define VPX_DECODER_H
/*!\defgroup decoder Decoder Algorithm Interface
* \ingroup codec
@@ -28,8 +29,6 @@
extern "C" {
#endif
-#ifndef VPX_DECODER_H
-#define VPX_DECODER_H
#include "vpx_codec.h"
/*!\brief Current ABI version number
@@ -328,9 +327,8 @@ extern "C" {
/*!@} - end defgroup cap_put_slice*/
/*!@} - end defgroup decoder*/
-
-#endif
-
#ifdef __cplusplus
}
#endif
+#endif
+
diff --git a/vpx/vpx_encoder.h b/vpx/vpx_encoder.h
index 56fd2d9cbb..56752cfcfb 100644
--- a/vpx/vpx_encoder.h
+++ b/vpx/vpx_encoder.h
@@ -7,7 +7,8 @@
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
-
+#ifndef VPX_ENCODER_H
+#define VPX_ENCODER_H
/*!\defgroup encoder Encoder Algorithm Interface
* \ingroup codec
@@ -28,8 +29,6 @@
extern "C" {
#endif
-#ifndef VPX_ENCODER_H
-#define VPX_ENCODER_H
#include "vpx_codec.h"
/*! Temporal Scalability: Maximum length of the sequence defining frame
@@ -930,8 +929,8 @@ extern "C" {
/*!@} - end defgroup encoder*/
-
-#endif
#ifdef __cplusplus
}
#endif
+#endif
+
--
GitLab