[libcamera-devel] libcamera: media_device: Fix \sa tags for MediaDevice::link

17226 diff mbox series

doxygen didn't create proper links to the overloads of
MediaDevice::link because the signatures didn't match due to an
additional 'const'

While at it remove the unnecessary `MediaDevice::` and wrap the lines

Fixes: b65feafe ("libcamera: media_device: Add functions to get a MediaLink")

Signed-off-by: Marvin Schmidt <marvin.schmidt1987@gmail.com>
---
 src/libcamera/media_device.cpp | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

Hi Marvin,

Thank you for the patch.

On Mon, Aug 29, 2022 at 03:59:50PM +0200, Marvin Schmidt via libcamera-devel wrote:
> doxygen didn't create proper links to the overloads of
> MediaDevice::link because the signatures didn't match due to an
> additional 'const'
> 
> While at it remove the unnecessary `MediaDevice::` and wrap the lines
> 
> Fixes: b65feafe ("libcamera: media_device: Add functions to get a MediaLink")

The standard format for fixes tags is a 12 digits commit ID. I'll fix
this when applying.

> Signed-off-by: Marvin Schmidt <marvin.schmidt1987@gmail.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  src/libcamera/media_device.cpp | 16 ++++++++++------
>  1 file changed, 10 insertions(+), 6 deletions(-)
> 
> diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp
> index 7c94da9e..52c8e66e 100644
> --- a/src/libcamera/media_device.cpp
> +++ b/src/libcamera/media_device.cpp
> @@ -352,8 +352,9 @@ MediaEntity *MediaDevice::getEntityByName(const std::string &name) const
>   * entity with name \a sourceName, to the pad at index \a sinkIdx of the
>   * sink entity with name \a sinkName, if any.
>   *
> - * \sa MediaDevice::link(const MediaEntity *source, unsigned int sourceIdx, const MediaEntity *sink, unsigned int sinkIdx) const
> - * \sa MediaDevice::link(const MediaPad *source, const MediaPad *sink) const
> + * \sa link(const MediaEntity *source, unsigned int sourceIdx,
> + *          const MediaEntity *sink, unsigned int sinkIdx)
> + * \sa link(const MediaPad *source, const MediaPad *sink)
>   *
>   * \return The link that connects the two pads, or nullptr if no such a link
>   * exists
> @@ -381,8 +382,9 @@ MediaLink *MediaDevice::link(const std::string &sourceName, unsigned int sourceI
>   * entity \a source, to the pad at index \a sinkIdx of the sink entity \a
>   * sink, if any.
>   *
> - * \sa MediaDevice::link(const std::string &sourceName, unsigned int sourceIdx, const std::string &sinkName, unsigned int sinkIdx) const
> - * \sa MediaDevice::link(const MediaPad *source, const MediaPad *sink) const
> + * \sa link(const std::string &sourceName, unsigned int sourceIdx,
> + *          const std::string &sinkName, unsigned int sinkIdx)
> + * \sa link(const MediaPad *source, const MediaPad *sink)
>   *
>   * \return The link that connects the two pads, or nullptr if no such a link
>   * exists
> @@ -404,8 +406,10 @@ MediaLink *MediaDevice::link(const MediaEntity *source, unsigned int sourceIdx,
>   * \param[in] source The source pad
>   * \param[in] sink The sink pad
>   *
> - * \sa MediaDevice::link(const std::string &sourceName, unsigned int sourceIdx, const std::string &sinkName, unsigned int sinkIdx) const
> - * \sa MediaDevice::link(const MediaEntity *source, unsigned int sourceIdx, const MediaEntity *sink, unsigned int sinkIdx) const
> + * \sa link(const std::string &sourceName, unsigned int sourceIdx,
> + *          const std::string &sinkName, unsigned int sinkIdx)
> + * \sa link(const MediaEntity *source, unsigned int sourceIdx,
> + *          const MediaEntity *sink, unsigned int sinkIdx)
>   *
>   * \return The link that connects the two pads, or nullptr if no such a link
>   * exists

Hello,

On 8/30/22 6:40 AM, Laurent Pinchart via libcamera-devel wrote:
> Hi Marvin,
>
> Thank you for the patch.
>
> On Mon, Aug 29, 2022 at 03:59:50PM +0200, Marvin Schmidt via libcamera-devel wrote:
>> doxygen didn't create proper links to the overloads of
>> MediaDevice::link because the signatures didn't match due to an
>> additional 'const'
>>
>> While at it remove the unnecessary `MediaDevice::` and wrap the lines
>>
>> Fixes: b65feafe ("libcamera: media_device: Add functions to get a MediaLink")
> The standard format for fixes tags is a 12 digits commit ID. I'll fix
> this when applying.
>
>> Signed-off-by: Marvin Schmidt <marvin.schmidt1987@gmail.com>
> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>
>
>> ---
>>   src/libcamera/media_device.cpp | 16 ++++++++++------
>>   1 file changed, 10 insertions(+), 6 deletions(-)
>>
>> diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp
>> index 7c94da9e..52c8e66e 100644
>> --- a/src/libcamera/media_device.cpp
>> +++ b/src/libcamera/media_device.cpp
>> @@ -352,8 +352,9 @@ MediaEntity *MediaDevice::getEntityByName(const std::string &name) const
>>    * entity with name \a sourceName, to the pad at index \a sinkIdx of the
>>    * sink entity with name \a sinkName, if any.
>>    *
>> - * \sa MediaDevice::link(const MediaEntity *source, unsigned int sourceIdx, const MediaEntity *sink, unsigned int sinkIdx) const
>> - * \sa MediaDevice::link(const MediaPad *source, const MediaPad *sink) const
>> + * \sa link(const MediaEntity *source, unsigned int sourceIdx,
>> + *          const MediaEntity *sink, unsigned int sinkIdx)
>> + * \sa link(const MediaPad *source, const MediaPad *sink)
>>    *
>>    * \return The link that connects the two pads, or nullptr if no such a link
>>    * exists
>> @@ -381,8 +382,9 @@ MediaLink *MediaDevice::link(const std::string &sourceName, unsigned int sourceI
>>    * entity \a source, to the pad at index \a sinkIdx of the sink entity \a
>>    * sink, if any.
>>    *
>> - * \sa MediaDevice::link(const std::string &sourceName, unsigned int sourceIdx, const std::string &sinkName, unsigned int sinkIdx) const
>> - * \sa MediaDevice::link(const MediaPad *source, const MediaPad *sink) const
>> + * \sa link(const std::string &sourceName, unsigned int sourceIdx,
>> + *          const std::string &sinkName, unsigned int sinkIdx)
>> + * \sa link(const MediaPad *source, const MediaPad *sink)
>>    *
>>    * \return The link that connects the two pads, or nullptr if no such a link
>>    * exists
>> @@ -404,8 +406,10 @@ MediaLink *MediaDevice::link(const MediaEntity *source, unsigned int sourceIdx,
>>    * \param[in] source The source pad
>>    * \param[in] sink The sink pad
>>    *
>> - * \sa MediaDevice::link(const std::string &sourceName, unsigned int sourceIdx, const std::string &sinkName, unsigned int sinkIdx) const
>> - * \sa MediaDevice::link(const MediaEntity *source, unsigned int sourceIdx, const MediaEntity *sink, unsigned int sinkIdx) const
>> + * \sa link(const std::string &sourceName, unsigned int sourceIdx,
>> + *          const std::string &sinkName, unsigned int sinkIdx)
>> + * \sa link(const MediaEntity *source, unsigned int sourceIdx,
>> + *          const MediaEntity *sink, unsigned int sinkIdx)
>>    *
>>    * \return The link that connects the two pads, or nullptr if no such a link
>>    * exists