| Message ID | 20200317201925.6515-1-laurent.pinchart@ideasonboard.com |
|---|---|
| State | Accepted |
| Commit | 49a35da2ceaee33a296f9e30b1cf784a656e0224 |
| Headers | show |
| Series |
|
| Related | show |
Hi Laurent, Thanks for your patch. On 2020-03-17 22:19:25 +0200, Laurent Pinchart wrote: > The doxygen \ref command is used to generate a reference to a function, > while adding parentheses after the function name is enough. Simplify the > documentation. Neat! > > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se> > --- > src/libcamera/v4l2_subdevice.cpp | 3 +-- > 1 file changed, 1 insertion(+), 2 deletions(-) > > diff --git a/src/libcamera/v4l2_subdevice.cpp b/src/libcamera/v4l2_subdevice.cpp > index e0985e05a8de..16b015595163 100644 > --- a/src/libcamera/v4l2_subdevice.cpp > +++ b/src/libcamera/v4l2_subdevice.cpp > @@ -228,8 +228,7 @@ int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format, > * "ActiveFormat" or \ref V4L2Subdevice::TryFormat "TryFormat" > * > * Apply the requested image format to the desired media pad and return the > - * actually applied format parameters, as \ref V4L2Subdevice::getFormat would > - * do. > + * actually applied format parameters, as getFormat() would do. > * > * \return 0 on success or a negative error code otherwise > */ > -- > Regards, > > Laurent Pinchart > > _______________________________________________ > libcamera-devel mailing list > libcamera-devel@lists.libcamera.org > https://lists.libcamera.org/listinfo/libcamera-devel
diff --git a/src/libcamera/v4l2_subdevice.cpp b/src/libcamera/v4l2_subdevice.cpp index e0985e05a8de..16b015595163 100644 --- a/src/libcamera/v4l2_subdevice.cpp +++ b/src/libcamera/v4l2_subdevice.cpp @@ -228,8 +228,7 @@ int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format, * "ActiveFormat" or \ref V4L2Subdevice::TryFormat "TryFormat" * * Apply the requested image format to the desired media pad and return the - * actually applied format parameters, as \ref V4L2Subdevice::getFormat would - * do. + * actually applied format parameters, as getFormat() would do. * * \return 0 on success or a negative error code otherwise */
The doxygen \ref command is used to generate a reference to a function, while adding parentheses after the function name is enough. Simplify the documentation. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> --- src/libcamera/v4l2_subdevice.cpp | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)