Merge pull request #1459 from rolalaro/doc_python_bindings

Doc python bindings
lagadic · Sep 12, 2024 · 3717c06 · 3717c06
2 parents d8a40d8 + 5aa4978
commit 3717c06
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 5 deletions.
diff --git a/modules/core/include/visp3/core/vpList.h b/modules/core/include/visp3/core/vpList.h
@@ -45,9 +45,8 @@
 
 #include <stdio.h>
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
 BEGIN_VISP_NAMESPACE
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
 /*!
   \class vpListElement
   \brief Each element of a list

diff --git a/modules/python/doc/rst/tutorials/misc/ukf-linear.rst b/modules/python/doc/rst/tutorials/misc/ukf-linear.rst
@@ -13,3 +13,4 @@ The state vector and measurements are explained in the  `C++ example <https://vi
 
 .. literalinclude:: /examples/ukf-linear-example.py
   :language: python
+  :lines: 35-
diff --git a/modules/python/doc/rst/tutorials/misc/ukf-nonlinear-linear-complex.rst b/modules/python/doc/rst/tutorials/misc/ukf-nonlinear-linear-complex.rst
@@ -11,3 +11,4 @@ The state vector and measurements are explained in the  `C++ example <https://vi
 
 .. literalinclude:: /examples/ukf-nonlinear-complex-example.py
   :language: python
+  :lines: 35-
diff --git a/modules/python/doc/rst/tutorials/misc/ukf-nonlinear-linear.rst b/modules/python/doc/rst/tutorials/misc/ukf-nonlinear-linear.rst
@@ -11,3 +11,4 @@ The state vector and measurements are explained in the  `C++ example <https://vi
 
 .. literalinclude:: /examples/ukf-nonlinear-example.py
   :language: python
+  :lines: 35-
diff --git a/modules/python/examples/ukf-linear-example.py b/modules/python/examples/ukf-linear-example.py
@@ -35,7 +35,7 @@
 
 """ @example ukf-linear-example.py
  Example of a simple linear use-case of the Unscented Kalman Filter (UKF). Using a UKF
- in this case is not necessary, it is done for learning purpous only.
+ in this case is not necessary, it is done for learning purpose only.
 
  The system we are interested in is a system moving on a 2D-plane.
 

diff --git a/modules/visual_features/include/visp3/visual_features/vpFeatureLuminance.h b/modules/visual_features/include/visp3/visual_features/vpFeatureLuminance.h
@@ -46,9 +46,8 @@
 #include <visp3/core/vpMatrix.h>
 #include <visp3/visual_features/vpBasicFeature.h>
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
 BEGIN_VISP_NAMESPACE
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
 /*!
  * \class vpLuminance
  * \brief Class that defines the luminance and gradient of a point.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,3 +13,4 @@ The state vector and measurements are explained in the `C++ example <https://vi

		.. literalinclude:: /examples/ukf-linear-example.py
		:language: python
		:lines: 35-
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,3 +11,4 @@ The state vector and measurements are explained in the `C++ example <https://vi

		.. literalinclude:: /examples/ukf-nonlinear-complex-example.py
		:language: python
		:lines: 35-