[FFmpeg-devel] [PATCH] avutil/refstruct: Fix documentation

[FFmpeg-devel] [PATCH] avutil/refstruct: Fix documentation

[Andreas Rheinhardt]

[-- Attachment #1: Type: text/plain, Size: 27 bytes --]

Patch attached.

- Andreas

[-- Attachment #2: 0001-avutil-refstruct-Fix-documentation.patch --]
[-- Type: text/x-patch, Size: 2966 bytes --]

From 0601964cbc4a9b1e5d78b8a8da76f1259cc56b52 Mon Sep 17 00:00:00 2001
From: Andreas Rheinhardt <andreas.rheinhardt@outlook.com>
Date: Mon, 10 Mar 2025 05:38:18 +0100
Subject: [PATCH] avutil/refstruct: Fix documentation

Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@outlook.com>
---
 libavutil/refstruct.h | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/libavutil/refstruct.h b/libavutil/refstruct.h
index 644d888284..967418bc16 100644
--- a/libavutil/refstruct.h
+++ b/libavutil/refstruct.h
@@ -74,7 +74,7 @@ typedef union {
  * the returned object is initially zeroed.
  *
  * @param size    Desired usable size of the returned object.
- * @param flags   A bitwise combination of av_refstruct_FLAG_* flags.
+ * @param flags   A bitwise combination of AV_REFSTRUCT_FLAG_* flags.
  * @param opaque  A pointer that will be passed to the free_cb callback.
  * @param free_cb A callback for freeing this object's content
  *                when its reference count reaches zero;
@@ -205,7 +205,7 @@ typedef struct AVRefStructPool AVRefStructPool;
  * provided, then free_cb will be called if init_cb fails.
  *
  * It will be called after reset_cb in case reset_cb and the
- * av_refstruct_POOL_FLAG_RESET_ON_INIT_ERROR flag are also set.
+ * AV_REFSTRUCT_POOL_FLAG_RESET_ON_INIT_ERROR flag are also set.
  *
  * The object passed to free_cb will be in the state left by
  * the callbacks applied earlier (init_cb potentially followed by reset_cb).
@@ -215,7 +215,7 @@ typedef struct AVRefStructPool AVRefStructPool;
  * If this flag is set, the entries will be zeroed before
  * being returned to the user (after the init or reset callbacks
  * have been called (if provided)). Furthermore, to avoid zeroing twice
- * it also makes the pool behave as if the av_refstruct_POOL_FLAG_NO_ZEROING
+ * it also makes the pool behave as if the AV_REFSTRUCT_POOL_FLAG_NO_ZEROING
  * flag had been provided.
  */
 #define AV_REFSTRUCT_POOL_FLAG_ZERO_EVERY_TIME                       (1 << 18)
@@ -229,11 +229,11 @@ AVRefStructPool *av_refstruct_pool_alloc(size_t size, unsigned flags);
  * Allocate an AVRefStructPool, potentially using complex callbacks.
  *
  * @param size size of the entries of the pool
- * @param flags a bitwise combination of av_refstruct_POOL_FLAG_* flags
+ * @param flags a bitwise combination of AV_REFSTRUCT_POOL_FLAG_* flags
  * @param opaque A pointer that will be passed to the callbacks below.
  * @param init  A callback that will be called directly after a new entry
  *              has been allocated. obj has already been zeroed unless
- *              the av_refstruct_POOL_FLAG_NO_ZEROING flag is in use.
+ *              the AV_REFSTRUCT_POOL_FLAG_NO_ZEROING flag is in use.
  * @param reset A callback that will be called after an entry has been
  *              returned to the pool and before it is reused.
  * @param free_entry A callback that will be called when an entry is freed
-- 
2.45.2


[-- Attachment #3: Type: text/plain, Size: 251 bytes --]

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

Re: [FFmpeg-devel] [PATCH] avutil/refstruct: Fix documentation

[Stefano Sabatini]

On date Monday 2025-03-10 05:39:30 +0100, Andreas Rheinhardt wrote:
> Patch attached.
> 
> - Andreas

> From 0601964cbc4a9b1e5d78b8a8da76f1259cc56b52 Mon Sep 17 00:00:00 2001
> From: Andreas Rheinhardt <andreas.rheinhardt@outlook.com>
> Date: Mon, 10 Mar 2025 05:38:18 +0100
> Subject: [PATCH] avutil/refstruct: Fix documentation
> 
> Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@outlook.com>
> ---
>  libavutil/refstruct.h | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/libavutil/refstruct.h b/libavutil/refstruct.h
> index 644d888284..967418bc16 100644
> --- a/libavutil/refstruct.h
> +++ b/libavutil/refstruct.h
> @@ -74,7 +74,7 @@ typedef union {
>   * the returned object is initially zeroed.
>   *
>   * @param size    Desired usable size of the returned object.
> - * @param flags   A bitwise combination of av_refstruct_FLAG_* flags.
> + * @param flags   A bitwise combination of AV_REFSTRUCT_FLAG_* flags.
>   * @param opaque  A pointer that will be passed to the free_cb callback.
>   * @param free_cb A callback for freeing this object's content
>   *                when its reference count reaches zero;
> @@ -205,7 +205,7 @@ typedef struct AVRefStructPool AVRefStructPool;
>   * provided, then free_cb will be called if init_cb fails.
>   *
>   * It will be called after reset_cb in case reset_cb and the
> - * av_refstruct_POOL_FLAG_RESET_ON_INIT_ERROR flag are also set.
> + * AV_REFSTRUCT_POOL_FLAG_RESET_ON_INIT_ERROR flag are also set.
>   *
>   * The object passed to free_cb will be in the state left by
>   * the callbacks applied earlier (init_cb potentially followed by reset_cb).
> @@ -215,7 +215,7 @@ typedef struct AVRefStructPool AVRefStructPool;
>   * If this flag is set, the entries will be zeroed before
>   * being returned to the user (after the init or reset callbacks
>   * have been called (if provided)). Furthermore, to avoid zeroing twice
> - * it also makes the pool behave as if the av_refstruct_POOL_FLAG_NO_ZEROING
> + * it also makes the pool behave as if the AV_REFSTRUCT_POOL_FLAG_NO_ZEROING
>   * flag had been provided.
>   */
>  #define AV_REFSTRUCT_POOL_FLAG_ZERO_EVERY_TIME                       (1 << 18)
> @@ -229,11 +229,11 @@ AVRefStructPool *av_refstruct_pool_alloc(size_t size, unsigned flags);
>   * Allocate an AVRefStructPool, potentially using complex callbacks.
>   *
>   * @param size size of the entries of the pool
> - * @param flags a bitwise combination of av_refstruct_POOL_FLAG_* flags
> + * @param flags a bitwise combination of AV_REFSTRUCT_POOL_FLAG_* flags
>   * @param opaque A pointer that will be passed to the callbacks below.
>   * @param init  A callback that will be called directly after a new entry
>   *              has been allocated. obj has already been zeroed unless
> - *              the av_refstruct_POOL_FLAG_NO_ZEROING flag is in use.
> + *              the AV_REFSTRUCT_POOL_FLAG_NO_ZEROING flag is in use.
>   * @param reset A callback that will be called after an entry has been
>   *              returned to the pool and before it is reused.
>   * @param free_entry A callback that will be called when an entry is freed
> -- 
> 2.45.2

sure, thanks
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".