[documentation] fix sample image and casing (#208)

FrancoisCarouge · Nov 14, 2022 · 7ab42ff · 7ab42ff
1 parent 06aad6b
commit 7ab42ff
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 7 deletions.
diff --git a/sample/ekf_4x1x0_soaring.cpp b/sample/ekf_4x1x0_soaring.cpp
@@ -10,7 +10,7 @@ namespace {
 
 template <typename Type, auto Size> using vector = Eigen::Vector<Type, Size>;
 
-//! @brief ArduPilot Plane Soaring
+//! @brief ArduPilot plane soaring.
 //!
 //! @copyright This example is transcribed from the ArduPilot Soaring Plane
 //! copyright ArduPilot Dev Team.

diff --git a/sample/kf_1x1x0_building_height.cpp b/sample/kf_1x1x0_building_height.cpp
@@ -4,7 +4,7 @@
 
 namespace fcarouge::sample {
 namespace {
-//! @brief Estimating the Height of a Building
+//! @brief Estimating the height of a building.
 //!
 //! @copyright This example is transcribed from KalmanFilter.NET copyright Alex
 //! Becker.
@@ -18,7 +18,7 @@ namespace {
 //! deviation) is 5 meters. The set of ten measurements is: 48.54m, 47.11m,
 //! 55.01m, 55.15m, 49.89m, 40.85m, 46.72m, 50.05m, 51.27m, 49.95m.
 //!
-//! @image image/kf_1x1x0_building_height.svg
+//! @image html ./sample/image/kf_1x1x0_building_height.svg
 //!
 //! @example kf_1x1x0_building_height.cpp
 [[maybe_unused]] auto kf_1x1x0_building_height{[] {

diff --git a/sample/kf_1x1x0_liquid_temperature.cpp b/sample/kf_1x1x0_liquid_temperature.cpp
@@ -5,7 +5,7 @@
 
 namespace fcarouge::sample {
 namespace {
-//! @brief Estimating the Temperature of the Liquid in a Tank
+//! @brief Estimating the temperature of the liquid in a tank.
 //!
 //! @copyright This example is transcribed from KalmanFilter.NET copyright Alex
 //! Becker.

diff --git a/sample/kf_1x1x1_dog_position.cpp b/sample/kf_1x1x1_dog_position.cpp
@@ -5,7 +5,7 @@
 
 namespace fcarouge::sample {
 namespace {
-//! @brief Estimating the Position of a Dog
+//! @brief Estimating the position of a dog.
 //!
 //! @copyright This example is transcribed from Kalman and Bayesian Filters in
 //! Python copyright Roger Labbe

diff --git a/sample/kf_2x1x1_rocket_altitude.cpp b/sample/kf_2x1x1_rocket_altitude.cpp
@@ -11,7 +11,7 @@ namespace {
 
 template <typename Type, auto Size> using vector = Eigen::Vector<Type, Size>;
 
-//! @brief Estimating the Rocket Altitude
+//! @brief Estimating the rocket altitude.
 //!
 //! @copyright This example is transcribed from KalmanFilter.NET copyright Alex
 //! Becker.

diff --git a/sample/kf_6x2x0_vehicle_location.cpp b/sample/kf_6x2x0_vehicle_location.cpp
@@ -27,7 +27,7 @@ struct divide final {
   }
 };
 
-//! @brief Estimating the Vehicle Location
+//! @brief Estimating the vehicle location.
 //!
 //! @copyright This example is transcribed from KalmanFilter.NET copyright Alex
 //! Becker.