From 268cc460014721b37bc8e7159128ef2f2c021aae Mon Sep 17 00:00:00 2001 From: JoelCourtney Date: Fri, 13 Sep 2024 17:00:33 -0700 Subject: [PATCH] Update doc comments --- .../gov/nasa/ammos/aerie/procedural/timeline/plan/Plan.kt | 6 ++++++ .../aerie/procedural/timeline/plan/SimulationResults.kt | 2 +- 2 files changed, 7 insertions(+), 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 index 599c880c70..dfdf77287c 100644 --- 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 > resource(name: String, deserializer: (List>) -> TL): TL } diff --git a/procedural/timeline/src/main/kotlin/gov/nasa/ammos/aerie/procedural/timeline/plan/SimulationResults.kt b/procedural/timeline/src/main/kotlin/gov/nasa/ammos/aerie/procedural/timeline/plan/SimulationResults.kt index cc16f96eef..58896179b1 100644 --- a/procedural/timeline/src/main/kotlin/gov/nasa/ammos/aerie/procedural/timeline/plan/SimulationResults.kt +++ b/procedural/timeline/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