docs(src): add examples alias and general cleanup (#2763)

tests/conftest.cpp

@@ -1,3 +1,9 @@
+/**
+ * @file tests/conftest.cpp
+ * @brief Common test fixtures for all tests.
+ * While not a header, this file should be included in all test files.
+ * @todo Separate parts of this into a header file.
+ */
 #include <filesystem>
 #include <gtest/gtest.h>
 

tests/unit/test_audio.cpp

@@ -1,5 +1,5 @@
 /**
- * @file tests/test_audio.cpp
+ * @file tests/unit/test_audio.cpp
  * @brief Test src/audio.*.
  */
 #include <bitset>

tests/unit/test_file_handler.cpp

@@ -1,5 +1,5 @@
 /**
- * @file tests/test_file_handler.cpp
+ * @file tests/unit/test_file_handler.cpp
  * @brief Test src/file_handler.*.
  */
 #include <src/file_handler.h>

tests/unit/test_httpcommon.cpp

@@ -1,5 +1,5 @@
 /**
- * @file tests/test_httpcommon.cpp
+ * @file tests/unit/test_httpcommon.cpp
  * @brief Test src/httpcommon.*.
  */
 #include <src/httpcommon.h>

tests/unit/test_logging.cpp

@@ -1,5 +1,5 @@
 /**
- * @file tests/test_logging.cpp
+ * @file tests/unit/test_logging.cpp
  * @brief Test src/logging.*.
  */
 #include <fstream>

tests/unit/test_video.cpp

@@ -1,5 +1,5 @@
 /**
- * @file tests/test_video.cpp
+ * @file tests/unit/test_video.cpp
  * @brief Test src/video.*.
  */
 #include <src/video.h>

tests/utils.cpp

@@ -1,8 +1,7 @@
 /**
- * @file utils.cpp
- * @brief Utility functions
+ * @file tests/utils.cpp
+ * @brief Definition for utility functions.
  */
-
 #include "utils.h"
 
 /**

tests/utils.h

@@ -1,8 +1,7 @@
 /**
- * @file utils.h
- * @brief Reusable functions for tests.
+ * @file tests/utils.h
+ * @brief Declarations for utility functions.
  */
-
 #pragma once
 
 #include <string>