Update doc comments

NASA-AMMOS · Sep 14, 2024 · 268cc46 · 268cc46
1 parent 7df33a9
commit 268cc46
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/procedural/timeline/src/main/kotlin/gov/nasa/ammos/aerie/procedural/timeline/plan/Plan.kt b/procedural/timeline/src/main/kotlin/gov/nasa/ammos/aerie/procedural/timeline/plan/Plan.kt
@@ -34,5 +34,11 @@ interface Plan {
   /** Queries all activity directives, deserializing them as [AnyDirective]. **/
   fun directives() = directives(null, AnyDirective.deserializer())
 
+  /**
+   * Query a resource profile from the external datasets associated with this plan.
+   *
+   * @param deserializer constructor of the profile, converting [SerializedValue]
+   * @param name string name of the resource
+   */
   fun <V: Any, TL: SerialSegmentOps<V, TL>> resource(name: String, deserializer: (List<Segment<SerializedValue>>) -> TL): TL
 }
diff --git a/...meline/src/main/kotlin/gov/nasa/ammos/aerie/procedural/timeline/plan/SimulationResults.kt b/...meline/src/main/kotlin/gov/nasa/ammos/aerie/procedural/timeline/plan/SimulationResults.kt
@@ -16,7 +16,7 @@ interface SimulationResults {
   fun simBounds(): Interval
 
   /**
-   * Query a resource profile from the database
+   * Query a resource profile from this simulation dataset.
    *
    * @param deserializer constructor of the profile, converting [SerializedValue]
    * @param name string name of the resource