diff mbox series

[FFmpeg-devel,v3,24/54] swscale: Fix bogus doxy comment #ifdefs

Message ID 20220925001121.37721-25-epirat07@gmail.com
State Accepted
Commit aba8cf654f598f52b745cd00a39ee8cc7b328487
Headers show
Series Various Doxygen fixes | expand

Commit Message

Marvin Scholz Sept. 25, 2022, 12:10 a.m. UTC 
The intention here was probably to document this as use of
conditionals does not make sense in a comment.

Fixes doxy warning:
  warning: explicit link request to 'if' could not be resolved
---
 libswscale/swscale.h | 15 +++++----------
 1 file changed, 5 insertions(+), 10 deletions(-)
diff mbox series

Patch

diff --git a/libswscale/swscale.h b/libswscale/swscale.h
index 3ebf7c698d..9794f6a258 100644
--- a/libswscale/swscale.h
+++ b/libswscale/swscale.h
@@ -324,22 +324,17 @@  unsigned int sws_receive_slice_alignment(const struct SwsContext *c);
  * @param brightness 16.16 fixed point brightness correction
  * @param contrast 16.16 fixed point contrast correction
  * @param saturation 16.16 fixed point saturation correction
-#if LIBSWSCALE_VERSION_MAJOR > 6
- * @return negative error code on error, non negative otherwise
-#else
- * @return -1 if not supported
-#endif
+ *
+ * @return A negative error code on error, non negative otherwise.
+ *         If `LIBSWSCALE_VERSION_MAJOR < 7`, returns -1 if not supported.
  */
 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
                              int srcRange, const int table[4], int dstRange,
                              int brightness, int contrast, int saturation);
 
 /**
-#if LIBSWSCALE_VERSION_MAJOR > 6
- * @return negative error code on error, non negative otherwise
-#else
- * @return -1 if not supported
-#endif
+ * @return A negative error code on error, non negative otherwise.
+ *         If `LIBSWSCALE_VERSION_MAJOR < 7`, returns -1 if not supported.
  */
 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
                              int *srcRange, int **table, int *dstRange,