Insert missing documentation

florianbecker · florianbecker · commit 7f213030feb5 · 2023-01-18T08:52:58.000+01:00
Remove file from list
diff --git a/source/CMakeLists.txt b/source/CMakeLists.txt
@@ -31,10 +31,6 @@
 project(sqlite_functions)
 
 add_library(${PROJECT_NAME}
-  ../.github/workflows/linux.yml
-  ../.github/workflows/macos.yml
-  ../.github/workflows/windows.yml
-  ../README.md
   SqliteError.h
   SqliteUtils.cpp
   SqliteUtils.h
@@ -76,4 +72,4 @@ add_custom_target(${PROJECT_NAME}_workflows
   ../.github/workflows/macos.yml
 #  ../.github/workflows/windows-codeql.yml
   ../.github/workflows/windows.yml
-)
+)
diff --git a/source/SqliteUtils.cpp b/source/SqliteUtils.cpp
@@ -66,8 +66,14 @@ namespace std { // NOSONAR
 
 namespace vx::sqlite_utils {
 
+  /**
+   * @brief Degrees of a half round move.
+   */
   constexpr std::int32_t halfCircleDegree = 180;
 
+  /**
+   * @brief Earth km.
+   */
   constexpr double earthBlubKm = 6378.137;
 
 #ifdef WIN32
@@ -266,7 +272,11 @@ namespace vx::sqlite_utils {
     return {};
   }
 
-  static double pi() { return std::atan(1)*4; }
+  /**
+   * @brief Generate own PI.
+   * @return Calculated pi value.
+   */
+  static double pi() { return std::atan( 1 ) * 4; }
 
   void distance( sqlite3_context *_context,
                  std::int32_t _argc,
