From d4c7f865f2cf80498c6ebb65f1c70220766ad5b1 Mon Sep 17 00:00:00 2001
From: Luc Maisonobe <luc@orekit.org>
Date: Tue, 20 Sep 2016 14:49:08 +0200
Subject: [PATCH] Improved javadoc.
---
src/main/java/org/orekit/rugged/api/Rugged.java | 1 -
.../orekit/rugged/refraction/AtmosphericRefraction.java | 7 ++++---
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/orekit/rugged/api/Rugged.java b/src/main/java/org/orekit/rugged/api/Rugged.java
index 0e6a67a2..fdddf722 100644
--- a/src/main/java/org/orekit/rugged/api/Rugged.java
+++ b/src/main/java/org/orekit/rugged/api/Rugged.java
@@ -55,7 +55,6 @@ import org.orekit.rugged.linesensor.LineSensor;
import org.orekit.rugged.linesensor.SensorMeanPlaneCrossing;
import org.orekit.rugged.linesensor.SensorPixel;
import org.orekit.rugged.linesensor.SensorPixelCrossing;
-import org.orekit.rugged.refraction.AtmosphericRefraction;
import org.orekit.rugged.utils.DSGenerator;
import org.orekit.rugged.utils.ExtendedEllipsoid;
import org.orekit.rugged.utils.NormalizedGeodeticPoint;
diff --git a/src/main/java/org/orekit/rugged/refraction/AtmosphericRefraction.java b/src/main/java/org/orekit/rugged/refraction/AtmosphericRefraction.java
index 6f413fdd..3874be05 100644
--- a/src/main/java/org/orekit/rugged/refraction/AtmosphericRefraction.java
+++ b/src/main/java/org/orekit/rugged/refraction/AtmosphericRefraction.java
@@ -25,12 +25,13 @@ import org.orekit.rugged.utils.NormalizedGeodeticPoint;
/**
* Interface for atmospheric refraction model.
* @author Sergio Esteves
+ * @since 2.0
*/
public interface AtmosphericRefraction {
/** Apply correction to the intersected point with an atmospheric refraction model.
- * @param satPos satellite position
- * @param satLos satellite line of sight
+ * @param satPos satellite position, in <em>body frame</em>
+ * @param satLos satellite line of sight, in <em>body frame</em>
* @param rawIntersection intersection point before refraction correction
* @param algorithm intersection algorithm
* @return corrected point with the effect of atmospheric refraction
@@ -39,7 +40,7 @@ public interface AtmosphericRefraction {
* {@link IntersectionAlgorithm#refineIntersection(ExtendedEllipsoid, Vector3D, Vector3D, NormalizedGeodeticPoint)}
*/
NormalizedGeodeticPoint applyCorrection(Vector3D satPos, Vector3D satLos, NormalizedGeodeticPoint rawIntersection,
- IntersectionAlgorithm algorithm)
+ IntersectionAlgorithm algorithm)
throws RuggedException;
}
--
GitLab