refactor codebase: standardize comment formatting across modules for improved readability

Author: allnes

modules/performance/tests/perf_tests.cpp

@@ -356,7 +356,7 @@ TEST(PerfTest, PipelineRunAndTaskRun_WithValidTask_ExecutesSuccessfully) {
 TEST(PerfTest, PrintPerfStatistic_WithNoneType_ThrowsException) {
   {
     auto task_ptr = std::make_shared<DummyTask>();
-    task_ptr->ExpectIncompleteLifecycle(); // Task not executed in a performance test
+    task_ptr->ExpectIncompleteLifecycle();  // Task not executed in a performance test
     Perf<int, int> perf(task_ptr);
     EXPECT_THROW(perf.PrintPerfStatistic("test"), std::runtime_error);
   }
@@ -616,7 +616,7 @@ TEST(TaskTest, Destructor_WithInvalidPipelineOrderAndPartialExecution_Terminates
       bool RunImpl() override { return true; }
       bool PostProcessingImpl() override { return true; }
     } task;
-    task.ExpectIncompleteLifecycle(); // Task has incomplete pipeline execution
+    task.ExpectIncompleteLifecycle();  // Task has incomplete pipeline execution
     task.Validation();
   }
 }

modules/runners/src/runners.cpp

@@ -85,8 +85,7 @@ int Init(int argc, char** argv) {
     listeners.Append(new UnreadMessagesDetector());
 
     status = RUN_ALL_TESTS();
-  } // TBB control object destroyed here
-
+  }  // TBB control object destroyed here
 
   const int finalize_res = MPI_Finalize();
   if (finalize_res != MPI_SUCCESS) {
@@ -105,7 +104,7 @@ int SimpleInit(int argc, char** argv) {
 
     testing::InitGoogleTest(&argc, argv);
     status = RUN_ALL_TESTS();
-  } // TBB control object destroyed here
+  }  // TBB control object destroyed here
 
   return status;
 }

modules/task/include/task.hpp

@@ -201,8 +201,8 @@ class Task {
   virtual ~Task() {
     if (stage_ != PipelineStage::kDone && stage_ != PipelineStage::kException && !expect_incomplete_) {
       // Immediate failure - better than global state pollution
-      std::cerr << "[TASK ERROR] Task destroyed without completing pipeline. Stage: "
-                << static_cast<int>(stage_) << std::endl;
+      std::cerr << "[TASK ERROR] Task destroyed without completing pipeline. Stage: " << static_cast<int>(stage_)
+                << std::endl;
       std::terminate();
     }
 #if _OPENMP >= 201811

modules/task/tests/task_additional.cpp

@@ -38,7 +38,7 @@ TEST_F(TaskAdditionalTest, TaskGetter_WithBasicTask_CreatesTaskSuccessfully) {
 
   // Test TaskGetter function
   auto getter_result = ppc::task::TaskGetter<GetterTestTask>(42);
-  getter_result->ExpectIncompleteLifecycle(); // Task is only created for testing, not executed
+  getter_result->ExpectIncompleteLifecycle();  // Task is only created for testing, not executed
 
   EXPECT_NE(getter_result, nullptr);
   EXPECT_EQ(getter_result->GetValue(), 42);
@@ -79,9 +79,9 @@ TEST_F(TaskAdditionalTest, TaskGetter_WithDifferentTaskTypes_CreatesTasksSuccess
 
   auto getter1 = ppc::task::TaskGetter<TaskType1>(std::string("test"));
   auto getter2 = ppc::task::TaskGetter<TaskType2>(3.14);
-  
-  getter1->ExpectIncompleteLifecycle(); // Tasks are only created for testing
-  getter2->ExpectIncompleteLifecycle(); // Tasks are only created for testing
+
+  getter1->ExpectIncompleteLifecycle();  // Tasks are only created for testing
+  getter2->ExpectIncompleteLifecycle();  // Tasks are only created for testing
 
   EXPECT_NE(getter1, nullptr);
   EXPECT_NE(getter2, nullptr);

modules/task/tests/task_tests.cpp

@@ -83,7 +83,7 @@ TEST(TaskTest, SlowTask_WithInt32Vector_ThrowsOnTimeout) {
   {
     std::vector<int32_t> in(20, 1);
     ppc::test::FakeSlowTask<std::vector<int32_t>, int32_t> test_task(in);
-    test_task.ExpectIncompleteLifecycle(); // Task may not complete due to timeout
+    test_task.ExpectIncompleteLifecycle();  // Task may not complete due to timeout
     ASSERT_EQ(test_task.Validation(), true);
     test_task.PreProcessing();
     test_task.Run();
@@ -95,7 +95,7 @@ TEST(TaskTest, TestTask_WithEmptyInput_ValidationFails) {
   {
     std::vector<int32_t> in;
     ppc::test::TestTask<std::vector<int32_t>, int32_t> test_task(in);
-    test_task.ExpectIncompleteLifecycle(); // Task fails validation so won't complete
+    test_task.ExpectIncompleteLifecycle();  // Task fails validation so won't complete
     ASSERT_EQ(test_task.Validation(), false);
   }
 }
@@ -124,7 +124,7 @@ TEST(TaskTest, TestTask_WithWrongExecutionOrder_ThrowsRuntimeError) {
   {
     std::vector<float> in(20, 1);
     ppc::test::TestTask<std::vector<float>, float> test_task(in);
-    test_task.ExpectIncompleteLifecycle(); // Task has wrong execution order
+    test_task.ExpectIncompleteLifecycle();  // Task has wrong execution order
     ASSERT_EQ(test_task.Validation(), true);
     test_task.PreProcessing();
     EXPECT_THROW(test_task.PostProcessing(), std::runtime_error);
@@ -135,7 +135,7 @@ TEST(TaskTest, TestTask_WithPrematurePostProcessingNoSteps_ThrowsRuntimeError) {
   {
     std::vector<float> in(20, 1);
     ppc::test::TestTask<std::vector<float>, float> test_task(in);
-    test_task.ExpectIncompleteLifecycle(); // Task throws exception so won't complete
+    test_task.ExpectIncompleteLifecycle();  // Task throws exception so won't complete
     EXPECT_THROW(test_task.PostProcessing(), std::runtime_error);
   }
 }
@@ -144,7 +144,7 @@ TEST(TaskTest, TestTask_WithPrematurePostProcessingAfterPreProcessing_ThrowsRunt
   {
     std::vector<float> in(20, 1);
     ppc::test::TestTask<std::vector<float>, float> test_task(in);
-    test_task.ExpectIncompleteLifecycle(); // Task throws exceptions so won't complete
+    test_task.ExpectIncompleteLifecycle();  // Task throws exceptions so won't complete
     EXPECT_THROW(test_task.PreProcessing(), std::runtime_error);
     EXPECT_THROW(test_task.PostProcessing(), std::runtime_error);
   }
@@ -228,7 +228,7 @@ TEST(TaskTest, TaskDestructor_WithIncompleteStage_SetsDestructorFailureFlag) {
       bool RunImpl() override { return true; }
       bool PostProcessingImpl() override { return true; }
     } task(in);
-    task.ExpectIncompleteLifecycle(); // Mark this task as expected to be incomplete
+    task.ExpectIncompleteLifecycle();  // Mark this task as expected to be incomplete
     task.Validation();
   }
   // No need to check global flag - task handles its own validation
@@ -244,7 +244,7 @@ TEST(TaskTest, TaskDestructor_WithEmptyTask_SetsDestructorFailureFlag) {
       bool RunImpl() override { return true; }
       bool PostProcessingImpl() override { return true; }
     } task(in);
-    task.ExpectIncompleteLifecycle(); // Mark this task as expected to be incomplete
+    task.ExpectIncompleteLifecycle();  // Mark this task as expected to be incomplete
   }
   // No need to check global flag - task handles its own validation
 }
@@ -264,7 +264,7 @@ TEST(TaskTest, InternalTimeTest_WithTimeoutExceeded_ThrowsRuntimeError) {
   {
     std::vector<int32_t> in(20, 1);
     SlowTask task(in);
-    task.ExpectIncompleteLifecycle(); // Task throws timeout exception
+    task.ExpectIncompleteLifecycle();  // Task throws timeout exception
     task.GetStateOfTesting() = StateOfTesting::kFunc;
     task.Validation();
     EXPECT_NO_THROW(task.PreProcessing());
@@ -285,7 +285,7 @@ class DummyTask : public Task<int, int> {
 TEST(TaskTest, Validation_WhenCalledTwice_ThrowsRuntimeError) {
   {
     auto task = std::make_shared<DummyTask>();
-    task->ExpectIncompleteLifecycle(); // Task throws exception so won't complete
+    task->ExpectIncompleteLifecycle();  // Task throws exception so won't complete
     task->Validation();
     EXPECT_THROW(task->Validation(), std::runtime_error);
   }
@@ -294,23 +294,23 @@ TEST(TaskTest, Validation_WhenCalledTwice_ThrowsRuntimeError) {
 TEST(TaskTest, PreProcessing_WhenCalledBeforeValidation_ThrowsRuntimeError) {
   {
     auto task = std::make_shared<DummyTask>();
-    task->ExpectIncompleteLifecycle(); // Task throws exception so won't complete
+    task->ExpectIncompleteLifecycle();  // Task throws exception so won't complete
     EXPECT_THROW(task->PreProcessing(), std::runtime_error);
   }
 }
 
 TEST(TaskTest, Run_WhenCalledBeforePreProcessing_ThrowsRuntimeError) {
   {
     auto task = std::make_shared<DummyTask>();
-    task->ExpectIncompleteLifecycle(); // Task throws exception so won't complete
+    task->ExpectIncompleteLifecycle();  // Task throws exception so won't complete
     EXPECT_THROW(task->Run(), std::runtime_error);
   }
 }
 
 TEST(TaskTest, PostProcessing_WhenCalledBeforeRun_ThrowsRuntimeError) {
   {
     auto task = std::make_shared<DummyTask>();
-    task->ExpectIncompleteLifecycle(); // Task throws exception so won't complete
+    task->ExpectIncompleteLifecycle();  // Task throws exception so won't complete
     task->Validation();
     task->PreProcessing();
     EXPECT_THROW(task->PostProcessing(), std::runtime_error);

modules/util/include/util.hpp

@@ -29,7 +29,6 @@ using NlohmannJsonTypeError = nlohmann::json::type_error;
 
 namespace ppc::util {
 
-
 enum GTestParamIndex : uint8_t { kTaskGetter, kNameTest, kTestParams };
 
 std::string GetAbsoluteTaskPath(const std::string& id_path, const std::string& relative_path);