[libcamera-devel] libcamera: ipa_interface: Fix doxygen warning

2639 diff mbox series

Doxygen generates the following warning:

src/libcamera/ipa_interface.cpp:262: warning: explicit link request to 'dup()' could not be resolved

Fix it by disabling link generation by prefixing the function name with
a %.

Fixes: 4b9bd6c3ad94 ("libcamera: ipa_interface: Document the ownership of dmabufs passed to map_buffers()")
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/ipa_interface.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Hi Laurent,

On 13/01/2020 23:56, Laurent Pinchart wrote:
> Doxygen generates the following warning:
> 
> src/libcamera/ipa_interface.cpp:262: warning: explicit link request to 'dup()' could not be resolved
> 
> Fix it by disabling link generation by prefixing the function name with
> a %.
> 

Thanks,

Confirmed this removes the compiler warning on my system, and renders
correctly in the generated doxygen output.

Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> Fixes: 4b9bd6c3ad94 ("libcamera: ipa_interface: Document the ownership of dmabufs passed to map_buffers()")
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  src/libcamera/ipa_interface.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/ipa_interface.cpp b/src/libcamera/ipa_interface.cpp
> index 900154497f82..5959e7deda6c 100644
> --- a/src/libcamera/ipa_interface.cpp
> +++ b/src/libcamera/ipa_interface.cpp
> @@ -261,7 +261,7 @@
>   * The dmabuf file descriptors provided in \a buffers are borrowed from the
>   * caller and are only guaranteed to be valid during the map_buffers() call.
>   * Should the callee need to store a copy of the file descriptors, it shall
> - * duplicate them first with ::dup().
> + * duplicate them first with ::%dup().
>   *
>   * \sa libcamera::IPAInterface::mapBuffers()
>   */
>

Hi Laurent,

Thanks for fixing my error :-)

On 2020-01-14 01:56:05 +0200, Laurent Pinchart wrote:
> Doxygen generates the following warning:
> 
> src/libcamera/ipa_interface.cpp:262: warning: explicit link request to 'dup()' could not be resolved
> 
> Fix it by disabling link generation by prefixing the function name with
> a %.
> 
> Fixes: 4b9bd6c3ad94 ("libcamera: ipa_interface: Document the ownership of dmabufs passed to map_buffers()")
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>

> ---
>  src/libcamera/ipa_interface.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/ipa_interface.cpp b/src/libcamera/ipa_interface.cpp
> index 900154497f82..5959e7deda6c 100644
> --- a/src/libcamera/ipa_interface.cpp
> +++ b/src/libcamera/ipa_interface.cpp
> @@ -261,7 +261,7 @@
>   * The dmabuf file descriptors provided in \a buffers are borrowed from the
>   * caller and are only guaranteed to be valid during the map_buffers() call.
>   * Should the callee need to store a copy of the file descriptors, it shall
> - * duplicate them first with ::dup().
> + * duplicate them first with ::%dup().
>   *
>   * \sa libcamera::IPAInterface::mapBuffers()
>   */
> -- 
> Regards,
> 
> Laurent Pinchart
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel