chore: fix @APinote tag casing and update .gitignore

bsommerfeld · bsommerfeld · commit 9695582d0202 · 2026-01-09T00:51:39.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,7 @@ target/
 *.iml
 dependency-reduced-pom.xml
 /javadoc/
+.flattened-pom.xml
+.DS_Store
+/docs/
+.vscode/
diff --git a/api/src/main/java/de/bsommerfeld/pathetic/api/pathing/heuristic/LinearHeuristicStrategy.java b/api/src/main/java/de/bsommerfeld/pathetic/api/pathing/heuristic/LinearHeuristicStrategy.java
@@ -21,7 +21,7 @@
  *
  * <p>Ideal for 3D grid-based environments with diagonal movement and path-straightness penalties.
  *
- * @apiNote This heuristic strategy operates on floored coordinates to ensure consistent and
+ * @api.Note This heuristic strategy operates on floored coordinates to ensure consistent and
  *     predictable pathfinding behavior in grid-based environments. The floored coordinates
  *     represent the discrete grid cell positions that nodes occupy, which is essential for
  *     maintaining the admissibility and consistency of heuristic calculations in traditional
diff --git a/api/src/main/java/de/bsommerfeld/pathetic/api/pathing/heuristic/SquaredHeuristicStrategy.java b/api/src/main/java/de/bsommerfeld/pathetic/api/pathing/heuristic/SquaredHeuristicStrategy.java
@@ -23,7 +23,7 @@
  *
  * <p>Ideal for high-performance pathfinding in large 3D environments.
  *
- * @apiNote This heuristic strategy operates on floored coordinates to ensure consistent and
+ * @api.Note This heuristic strategy operates on floored coordinates to ensure consistent and
  *     predictable pathfinding behavior in grid-based environments. The floored coordinates
  *     represent the discrete grid cell positions that nodes occupy, which is essential for
  *     maintaining the admissibility and consistency of heuristic calculations in traditional
diff --git a/api/src/main/java/de/bsommerfeld/pathetic/api/pathing/processing/Processor.java b/api/src/main/java/de/bsommerfeld/pathetic/api/pathing/processing/Processor.java
@@ -6,7 +6,7 @@
  * Base interface for pathfinding processors. It defines lifecycle methods that can be implemented
  * by concrete processors to initialize or finalize resources or states related to a path search.
  *
- * @apiNote Processors must be thread-safe.
+ * @api.Note Processors must be thread-safe.
  */
 public interface Processor { // PathPosition is implied globally for pathetic
   /**

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`*`
`22`	`22`	`* <p>Ideal for 3D grid-based environments with diagonal movement and path-straightness penalties.`
`23`	`23`	`*`
`24`		`- * @apiNote This heuristic strategy operates on floored coordinates to ensure consistent and`
	`24`	`+ * @api.Note This heuristic strategy operates on floored coordinates to ensure consistent and`
`25`	`25`	`* predictable pathfinding behavior in grid-based environments. The floored coordinates`
`26`	`26`	`* represent the discrete grid cell positions that nodes occupy, which is essential for`
`27`	`27`	`* maintaining the admissibility and consistency of heuristic calculations in traditional`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`*`
`24`	`24`	`* <p>Ideal for high-performance pathfinding in large 3D environments.`
`25`	`25`	`*`
`26`		`- * @apiNote This heuristic strategy operates on floored coordinates to ensure consistent and`
	`26`	`+ * @api.Note This heuristic strategy operates on floored coordinates to ensure consistent and`
`27`	`27`	`* predictable pathfinding behavior in grid-based environments. The floored coordinates`
`28`	`28`	`* represent the discrete grid cell positions that nodes occupy, which is essential for`
`29`	`29`	`* maintaining the admissibility and consistency of heuristic calculations in traditional`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`* Base interface for pathfinding processors. It defines lifecycle methods that can be implemented`
`7`	`7`	`* by concrete processors to initialize or finalize resources or states related to a path search.`
`8`	`8`	`*`
`9`		`- * @apiNote Processors must be thread-safe.`
	`9`	`+ * @api.Note Processors must be thread-safe.`
`10`	`10`	`*/`
`11`	`11`	`public interface Processor { // PathPosition is implied globally for pathetic`
`12`	`12`	`/**`