diff mbox series

[FFmpeg-devel] avutil/display: Drop wrong comments about matrices being allocated

Message ID AS8P250MB0744497B7C1C89DF59095EA58F539@AS8P250MB0744.EURP250.PROD.OUTLOOK.COM
State Accepted
Commit 3d8754cd091d81ed8e39978618cb441ebbc69ea5
Headers show
Series [FFmpeg-devel] avutil/display: Drop wrong comments about matrices being allocated | expand

Checks

Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Andreas Rheinhardt Sept. 25, 2022, 5:12 p.m. UTC 
These functions work just as well with stack based matrices.

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

Comments

Andreas Rheinhardt Sept. 28, 2022, 1:05 a.m. UTC | #1 
Andreas Rheinhardt:
> These functions work just as well with stack based matrices.
> 
> Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@outlook.com>
> ---
>  libavutil/display.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/libavutil/display.h b/libavutil/display.h
> index 31d8bef361..0c73bff5da 100644
> --- a/libavutil/display.h
> +++ b/libavutil/display.h
> @@ -90,8 +90,8 @@ double av_display_rotation_get(const int32_t matrix[9]);
>   * Initialize a transformation matrix describing a pure clockwise
>   * rotation by the specified angle (in degrees).
>   *
> - * @param matrix an allocated transformation matrix (will be fully overwritten
> - *               by this function)
> + * @param[out] matrix a transformation matrix (will be fully overwritten
> + *                    by this function)
>   * @param angle rotation angle in degrees.
>   */
>  void av_display_rotation_set(int32_t matrix[9], double angle);
> @@ -99,7 +99,7 @@ void av_display_rotation_set(int32_t matrix[9], double angle);
>  /**
>   * Flip the input matrix horizontally and/or vertically.
>   *
> - * @param matrix an allocated transformation matrix
> + * @param[in,out] matrix a transformation matrix
>   * @param hflip whether the matrix should be flipped horizontally
>   * @param vflip whether the matrix should be flipped vertically
>   */

Will apply tonight unless there are objections.

- Andreas
diff mbox series

Patch

diff --git a/libavutil/display.h b/libavutil/display.h
index 31d8bef361..0c73bff5da 100644
--- a/libavutil/display.h
+++ b/libavutil/display.h
@@ -90,8 +90,8 @@  double av_display_rotation_get(const int32_t matrix[9]);
  * Initialize a transformation matrix describing a pure clockwise
  * rotation by the specified angle (in degrees).
  *
- * @param matrix an allocated transformation matrix (will be fully overwritten
- *               by this function)
+ * @param[out] matrix a transformation matrix (will be fully overwritten
+ *                    by this function)
  * @param angle rotation angle in degrees.
  */
 void av_display_rotation_set(int32_t matrix[9], double angle);
@@ -99,7 +99,7 @@  void av_display_rotation_set(int32_t matrix[9], double angle);
 /**
  * Flip the input matrix horizontally and/or vertically.
  *
- * @param matrix an allocated transformation matrix
+ * @param[in,out] matrix a transformation matrix
  * @param hflip whether the matrix should be flipped horizontally
  * @param vflip whether the matrix should be flipped vertically
  */