diff mbox series

[FFmpeg-devel,v3,3/4] avcodec/bswapdsp: add documentation

Message ID 20221213024216.259-3-mindmark@gmail.com
State New
Headers show
Series [FFmpeg-devel,v3,1/4] avcodec/bswapdsp: remove unused cextern | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Mark Reid Dec. 13, 2022, 2:42 a.m. UTC 
From: Mark Reid <mindmark@gmail.com>

---
 libavcodec/bswapdsp.h | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
diff mbox series

Patch

diff --git a/libavcodec/bswapdsp.h b/libavcodec/bswapdsp.h
index 10519cfd2e..ecc37d2c56 100644
--- a/libavcodec/bswapdsp.h
+++ b/libavcodec/bswapdsp.h
@@ -21,11 +21,44 @@ 
 
 #include <stdint.h>
 
+/**
+ * @file
+ * Optimized buffer byte swapping routines.
+ */
+
 typedef struct BswapDSPContext {
+    /**
+     * Byte swap 32 bit elements in a buffer.
+
+     * @param dst Destination buffer.
+     * @param src Source buffer, may be the same as dst.
+     * @param len The number of elements in the buffer.
+     *
+     */
+     /** @{ */
     void (*bswap32_buf)(uint32_t *dst, const uint32_t *src, int len);
+    /** @} */
+
+    /**
+     * Byte swap 16 bit elements in a buffer.
+     *
+     * @param dst Destination buffer.
+     * @param src Source buffer, may be the same as dst.
+     * @param len The number of elements in the buffer.
+     *
+     */
+    /** @{ */
     void (*bswap16_buf)(uint16_t *dst, const uint16_t *src, int len);
+    /** @} */
 } BswapDSPContext;
 
+
+/**
+ * Initialize BswapDSPContext function pointers.
+ *
+ * @param c pointer to BswapDSPContext
+ *
+ */
 void ff_bswapdsp_init(BswapDSPContext *c);
 void ff_bswapdsp_init_riscv(BswapDSPContext *c);
 void ff_bswapdsp_init_x86(BswapDSPContext *c);