updated headers

popmonkey · popmonkey · commit ddcb81637ea0 · 2026-01-14T17:11:07.000-08:00
diff --git a/include/jres_solver/jres_solver.hpp b/include/jres_solver/jres_solver.hpp
@@ -1,6 +1,6 @@
 /**
  * @author popmonkey+jres@gmail.com
- * @file jres_solver.hpp
+ * @file include/jres_solver/jres_solver.hpp
  * @brief Public C-API for the JRES Solver Library.
  *
  * This file defines the C-style interface for the solver,
diff --git a/src/analysis/capacity_analyzer.cpp b/src/analysis/capacity_analyzer.cpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file src/analysis/capacity_analyzer.cpp
+ * @brief Implementation of capacity analysis.
+ */
 #include "capacity_analyzer.hpp"
 #include <sstream>
 #include <iomanip>
diff --git a/src/analysis/capacity_analyzer.hpp b/src/analysis/capacity_analyzer.hpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file src/analysis/capacity_analyzer.hpp
+ * @brief Header for capacity analysis.
+ */
 #pragma once
 #include "../jres_internal_types.hpp"
 
diff --git a/src/analysis/solver_diagnostics.cpp b/src/analysis/solver_diagnostics.cpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file src/analysis/solver_diagnostics.cpp
+ * @brief Implementation of solver diagnostics.
+ */
 #include "solver_diagnostics.hpp"
 #include "capacity_analyzer.hpp"
 #include "../utils/date_utils.hpp"
diff --git a/src/analysis/solver_diagnostics.hpp b/src/analysis/solver_diagnostics.hpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file src/analysis/solver_diagnostics.hpp
+ * @brief Header for solver diagnostics.
+ */
 #pragma once
 
 #include "../jres_internal_types.hpp"
diff --git a/src/constraints/balancing.cpp b/src/constraints/balancing.cpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file src/constraints/balancing.cpp
+ * @brief Implementation of load balancing constraints.
+ */
 #include "balancing.hpp"
 #include "Highs.h"
 #include <cmath>
diff --git a/src/constraints/balancing.hpp b/src/constraints/balancing.hpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file src/constraints/balancing.hpp
+ * @brief Header for load balancing constraints.
+ */
 #pragma once
 #include "../jres_internal_types.hpp"
 #include <map>
diff --git a/src/constraints/max_busy_time.cpp b/src/constraints/max_busy_time.cpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file src/constraints/max_busy_time.cpp
+ * @brief Implementation of maximum busy time constraints.
+ */
 #include "max_busy_time.hpp"
 #include "Highs.h"
 #include <chrono>
diff --git a/src/constraints/max_busy_time.hpp b/src/constraints/max_busy_time.hpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file src/constraints/max_busy_time.hpp
+ * @brief Header for maximum busy time constraints.
+ */
 #pragma once
 #include "../jres_internal_types.hpp"
 #include <map>
diff --git a/src/constraints/minimum_rest.cpp b/src/constraints/minimum_rest.cpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file src/constraints/minimum_rest.cpp
+ * @brief Implementation of minimum rest constraints.
+ */
 #include "minimum_rest.hpp"
 #include "Highs.h"
 #include <algorithm>
diff --git a/src/constraints/minimum_rest.hpp b/src/constraints/minimum_rest.hpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file src/constraints/minimum_rest.hpp
+ * @brief Header for minimum rest constraints.
+ */
 #pragma once
 #include "../jres_internal_types.hpp"
 #include <map>
diff --git a/test/test_availability_boundaries.cpp b/test/test_availability_boundaries.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_availability_boundaries.cpp
  * @brief Tests for precise availability boundary conditions.
  */
diff --git a/test/test_availability_overlap.cpp b/test/test_availability_overlap.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_availability_overlap.cpp
  * @brief Tests for availability overlap detection.
  */
diff --git a/test/test_balancing.cpp b/test/test_balancing.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_balancing.cpp
  * @brief Tests for the driver stint balancing logic.
  */
diff --git a/test/test_constraints.cpp b/test/test_constraints.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_constraints.cpp
  * @brief Tests for various hard constraints (infeasibility, preferred slots, coverage).
  */
diff --git a/test/test_diagnosis.cpp b/test/test_diagnosis.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_diagnosis.cpp
  * @brief Tests for the solver's diagnostic output capability.
  */
diff --git a/test/test_errors.cpp b/test/test_errors.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_errors.cpp
  * @brief Tests for error handling and input validation.
  */
diff --git a/test/test_fair_share.cpp b/test/test_fair_share.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_fair_share.cpp
  * @brief Tests for the "Fair Share" rule enforcement.
  */
diff --git a/test/test_first_stint.cpp b/test/test_first_stint.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_first_stint.cpp
  * @brief Tests for the firstStintDriver hard constraint.
  */
diff --git a/test/test_formatter_csv.cpp b/test/test_formatter_csv.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_formatter_csv.cpp
  * @brief Tests for CSV output formatting.
  */
diff --git a/test/test_formatter_itinerary.cpp b/test/test_formatter_itinerary.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_formatter_itinerary.cpp
  * @brief Tests for itinerary generation logic.
  */
diff --git a/test/test_formatter_summary.cpp b/test/test_formatter_summary.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_formatter_summary.cpp
  * @brief Tests for summary report generation.
  */
diff --git a/test/test_hard_consecutive_limit.cpp b/test/test_hard_consecutive_limit.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_hard_consecutive_limit.cpp
  * @brief Tests for hard constraints on consecutive stints.
  */
diff --git a/test/test_max_busy.cpp b/test/test_max_busy.cpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file test/test_max_busy.cpp
+ * @brief Tests for max busy time logic.
+ */
 #include "gtest/gtest.h"
 #include "jres_solver/jres_solver.hpp"
 #include "jres_internal_types.hpp"
diff --git a/test/test_max_busy_defaults.cpp b/test/test_max_busy_defaults.cpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file test/test_max_busy_defaults.cpp
+ * @brief Tests for max busy time defaults.
+ */
 #include "gtest/gtest.h"
 #include "jres_solver/jres_solver.hpp"
 #include "jres_internal_types.hpp"
diff --git a/test/test_max_busy_mixed_roles.cpp b/test/test_max_busy_mixed_roles.cpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file test/test_max_busy_mixed_roles.cpp
+ * @brief Tests for max busy time with mixed roles.
+ */
 #include "gtest/gtest.h"
 #include "jres_solver/jres_solver.hpp"
 #include "jres_internal_types.hpp"
diff --git a/test/test_minimum_rest.cpp b/test/test_minimum_rest.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_minimum_rest.cpp
  * @brief Tests for minimum rest time enforcement.
  */
diff --git a/test/test_optimization.cpp b/test/test_optimization.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_optimization.cpp
  * @brief Tests for optimization incentives (consecutive stints, preferences, penalties).
  */
diff --git a/test/test_role_coupling.cpp b/test/test_role_coupling.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_role_coupling.cpp
  * @brief Tests for role coupling incentives (Driver -> Spotter transition).
  */
diff --git a/test/test_rotation_beat.cpp b/test/test_rotation_beat.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_rotation_beat.cpp
  * @brief Tests for rotation beat (rhythm) enforcement.
  */
diff --git a/test/test_spotter_balancing.cpp b/test/test_spotter_balancing.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_spotter_balancing.cpp
  * @brief Tests for spotter workload balancing.
  */
diff --git a/test/test_spotter_modes.cpp b/test/test_spotter_modes.cpp
@@ -1,4 +1,5 @@
 /**
+ * @author popmonkey+jres@gmail.com
  * @file test/test_spotter_modes.cpp
  * @brief Tests for different spotter scheduling modes (None, Integrated, Sequential).
  */
diff --git a/test/test_validation.cpp b/test/test_validation.cpp
@@ -1,3 +1,8 @@
+/**
+ * @author popmonkey+jres@gmail.com
+ * @file test/test_validation.cpp
+ * @brief Tests for input validation.
+ */
 #include "gtest/gtest.h"
 #include "jres_solver/jres_solver.hpp"
 #include <string>

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`/**`
`2`	`2`	`* @author popmonkey+jres@gmail.com`
`3`		`- * @file jres_solver.hpp`
	`3`	`+ * @file include/jres_solver/jres_solver.hpp`
`4`	`4`	`* @brief Public C-API for the JRES Solver Library.`
`5`	`5`	`*`
`6`	`6`	`* This file defines the C-style interface for the solver,`