Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix warnings reported by doxygen 1.9.8 #1545

Merged
merged 1 commit into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions doc/tutorial/bridge/opencv/tutorial-bridge-opencv.dox
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ When \f$Z_c \neq 0\f$, the previous equation is equivalent to the following:
x &=& X_c / Z_c \\
y &=& Y_c / Z_c \\
u &=& u_0 + x \; p_x \\
v &=& v_0 + y \; p_y
v &=& v_0 + y \; p_y
\end{array}
\f]

Expand Down Expand Up @@ -92,7 +92,7 @@ The following table gives the correspondences between ViSP and OpenCV parameters
& k_5 = 0 \\
& k_6 = 0 \\
& p_1 = 0 \\
& p_2 = 0
& p_2 = 0
\end{array}
\f]

Expand Down Expand Up @@ -124,16 +124,16 @@ There is also tutorial-bridge-opencv-image.cpp from where the following snippets
before saving the converted color image
\snippet tutorial-bridge-opencv-image.cpp Save OpenCV color image

- **Grey scale image conversion**
- **Gray scale image conversion**

The following code allows to read a grey scale image with ViSP. Note here that if the
The following code allows to read a gray scale image with ViSP. Note here that if the
input image (ie. `monkey.jpeg`) is a color image, vpImageIo::read() converts implicitly
the color image in a grey scale image:
\snippet tutorial-bridge-opencv-image.cpp Load ViSP grey image
the color image in a gray scale image:
\snippet tutorial-bridge-opencv-image.cpp Load ViSP gray image
and then convert the image in OpenCV using:
\snippet tutorial-bridge-opencv-image.cpp Convert to OpenCV grey image
before saving the converted grey image
\snippet tutorial-bridge-opencv-image.cpp Save OpenCV grey image
\snippet tutorial-bridge-opencv-image.cpp Convert to OpenCV gray image
before saving the converted gray image
\snippet tutorial-bridge-opencv-image.cpp Save OpenCV gray image

\subsection tutorial_bridge_opencv_image_cv_to_vp From OpenCV to ViSP image conversion

Expand All @@ -146,14 +146,14 @@ There is also tutorial-bridge-opencv-image.cpp from where the following snippets
before saving the converted color image
\snippet tutorial-bridge-opencv-image.cpp Save ViSP color image

- **Grey scale image conversion**
- **Gray scale image conversion**

The following code allows to read a grey scale image with OpenCV:
\snippet tutorial-bridge-opencv-image.cpp Load OpenCV grey image
The following code allows to read a gray scale image with OpenCV:
\snippet tutorial-bridge-opencv-image.cpp Load OpenCV gray image
and then convert the image in ViSP using:
\snippet tutorial-bridge-opencv-image.cpp Convert to ViSP grey image
before saving the converted grey image
\snippet tutorial-bridge-opencv-image.cpp Save ViSP grey image
\snippet tutorial-bridge-opencv-image.cpp Convert to ViSP gray image
before saving the converted gray image
\snippet tutorial-bridge-opencv-image.cpp Save ViSP gray image

\section tutorial_bridge_opencv_matrix Matrix conversions

Expand All @@ -171,7 +171,7 @@ Note that each element of a ViSP matrix is a double and that ViSP matrices are r

In the following subsections we illustrate how to convert a vpMatrix to a `cv::Mat`, but the code could be easily
adapted to other ViSP specific matrices as long as the corresponding OpenCV matrix contains double
elements and that it has the same size as the ViSP specific matrix.
elements and that it has the same size as the ViSP specific matrix.

\subsection tutorial_bridge_opencv_matrix_cv_to_vp From OpenCV to ViSP matrix conversion

Expand All @@ -186,11 +186,11 @@ elements and that it has the same size as the ViSP specific matrix.

The content of the matrices is now the following:
\verbatim
M_cv:
M_cv:
[1, 2, 3, 4;
5, 6, 7, 8;
9, 10, 11, 12]
M:
M:
1 2 3 4
5 6 7 8
9 10 11 12
Expand All @@ -209,11 +209,11 @@ M:

The content of the matrices is now the following:
\verbatim
M:
M:
1 2 3 4
5 6 7 8
9 10 11 12
M_cv_deep:
M_cv_deep:
[1, 2, 3, 4;
5, 6, 7, 8;
9, 10, 11, 12]
Expand All @@ -226,11 +226,11 @@ M_cv_deep:

The content of the matrices is now the following:
\verbatim
M:
M:
1 2 3 4
5 6 7 8
9 10 11 12
M_cv:
M_cv:
[1, 2, 3, 4;
5, 6, 7, 8;
9, 10, 11, 12]
Expand All @@ -243,11 +243,11 @@ M_cv:
As expected, the content of `M_cv` matrix is also changed:
\verbatim
Set M = eye
M:
M:
1 0 0 0
0 1 0 0
0 0 1 0
M_cv:
M_cv:
[1, 0, 0, 0;
0, 1, 0, 0;
0, 0, 1, 0]
Expand Down
10 changes: 5 additions & 5 deletions modules/ar/test/catchPanda.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,12 @@
*/

/*!
\example catchJsonCamera.cpp
\example catchPanda.cpp

Test saving and parsing JSON configuration for vpCameraParameters.
Test saving and parsing JSON configuration for Panda 3D renderer.
*/

#include <visp3/core/vpCameraParameters.h>
#include <visp3/core/vpIoTools.h>
#include <visp3/core/vpConfig.h>

#if defined(VISP_HAVE_PANDA3D) && defined(VISP_HAVE_CATCH2)
#include <visp3/ar/vpPanda3DBaseRenderer.h>
Expand All @@ -53,7 +52,6 @@ using namespace VISP_NAMESPACE_NAME;

#include <random>


vpPanda3DRenderParameters defaultRenderParams()
{
vpCameraParameters cam(600, 600, 160, 120);
Expand Down Expand Up @@ -88,6 +86,8 @@ int main(int argc, char *argv[])

#else

#include <stdlib.h>

int main() { return EXIT_SUCCESS; }

#endif
19 changes: 10 additions & 9 deletions modules/core/include/visp3/core/vpImage_getters.h
Original file line number Diff line number Diff line change
Expand Up @@ -623,15 +623,16 @@ template <> inline void vpImage<float>::getMinMaxValue(float &min, float &max, b
}

/*!
\brief Look for the minimum and the maximum value within the 3-channels float bitmap
\param min : The minimal values within the bitmap.
\param max : The maximal values within the bitmap.
\param onlyFiniteVal : If true, consider only finite values.

\sa getMaxValue()
\sa getMinValue()
\sa getMinMaxLoc()
*/
* \relates vpImage
* \brief Look for the minimum and the maximum value within the 3-channels float bitmap
* \param min : The minimal values within the bitmap.
* \param max : The maximal values within the bitmap.
* \param onlyFiniteVal : If true, consider only finite values.
*
* \sa getMaxValue()
* \sa getMinValue()
* \sa getMinMaxLoc()
*/
template <> inline void vpImage<vpRGBf>::getMinMaxValue(vpRGBf &min, vpRGBf &max, bool onlyFiniteVal) const
{
if (npixels == 0) {
Expand Down
4 changes: 2 additions & 2 deletions modules/tracker/rbt/test/catchRBT.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@
*/

/*!
\file testMbtJsonSettings.cpp
\example catchRBT.cpp

Test test saving and parsing JSON configuration for vpMbGenericTracker
Test saving and parsing JSON configuration for vpRBTracker.
*/

#include <visp3/core/vpConfig.h>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! \example tutorial-compare-auto-gamma
//! \example tutorial-compare-auto-gamma.cpp

#include <iostream>
#include <visp3/core/vpConfig.h>
Expand Down
Loading