From dfbdce49f87f40b64f932b39352b196f2876f8cc Mon Sep 17 00:00:00 2001
From: Hengwen Zhang <hengwen.zhang@rwth-aachen.de>
Date: Tue, 17 Nov 2020 13:05:54 +0100
Subject: [PATCH] Add some doc

---
 .../montisim/simulation/vehicle/task/goal/PathGoal.java     | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/vehicle/src/main/java/de/rwth/montisim/simulation/vehicle/task/goal/PathGoal.java b/vehicle/src/main/java/de/rwth/montisim/simulation/vehicle/task/goal/PathGoal.java
index 68685e56..c1e6a8ce 100644
--- a/vehicle/src/main/java/de/rwth/montisim/simulation/vehicle/task/goal/PathGoal.java
+++ b/vehicle/src/main/java/de/rwth/montisim/simulation/vehicle/task/goal/PathGoal.java
@@ -15,6 +15,12 @@ import java.util.stream.Collectors;
 
 
 /**
+ * PathGoal is used for setting up a set of locations, which a vehicle must or must
+ * not reach. The order in the path matters, they will be considered in the exact
+ * order as they are given.
+ *
+ * For example, path = [node1, node2, ...] means node2
+ * can only be considered, after node1 has been reached by the vehicle.
  *
  */
 @Typed
-- 
GitLab