From 21d5b9bbef5dbb8e802870894973b6bf94f2c446 Mon Sep 17 00:00:00 2001
From: Luc Maisonobe <luc@orekit.org>
Date: Tue, 27 May 2014 10:49:51 +0200
Subject: [PATCH] Fixed javadoc warnings.
---
src/main/java/org/orekit/rugged/api/LineSensor.java | 11 ++++++-----
src/main/java/org/orekit/rugged/api/Rugged.java | 3 ++-
2 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/src/main/java/org/orekit/rugged/api/LineSensor.java b/src/main/java/org/orekit/rugged/api/LineSensor.java
index 245b27fb..e8f0919a 100644
--- a/src/main/java/org/orekit/rugged/api/LineSensor.java
+++ b/src/main/java/org/orekit/rugged/api/LineSensor.java
@@ -149,11 +149,6 @@ public class LineSensor {
}
/** Get the pixel normalized line-of-sight.
- * <p>
- * The {@link #getLos(int) line-of-sight}, {@link #getTransversal(int) transversal}
- * and {@link #getCross(int) cross} directions form a right-handed frame aligned
- * with the pixel.
- * </p>
* @param i pixel index (must be between 0 and {@link #getNbPixels()}
* @return pixel normalized line-of-sight
*/
@@ -205,6 +200,12 @@ public class LineSensor {
}
/** Get the relative azimuth of a direction with respect to a pixel.
+ * <p>
+ * The relative azimuth is computed along the sensor line. As it is
+ * relative to current pixel, it is 0 when the direction is aligned
+ * with pixel i, and the sign is consistent with {@link #getMeanPlaneNormal()
+ * mean plane normal} orientation.
+ * </p>
* @param direction direction to check
* @param i pixel index (must be between 0 and {@link #getNbPixels()}
* @return relative azimuth of direction
diff --git a/src/main/java/org/orekit/rugged/api/Rugged.java b/src/main/java/org/orekit/rugged/api/Rugged.java
index b8b1db70..f2ddae28 100644
--- a/src/main/java/org/orekit/rugged/api/Rugged.java
+++ b/src/main/java/org/orekit/rugged/api/Rugged.java
@@ -250,6 +250,7 @@ public class Rugged {
* @param lightTimeCorrection if true, the light travel time between ground
* and spacecraft is compensated for more accurate localization
* @see #isLightTimeCorrected()
+ * @see #setAberrationOfLightCorrection(boolean)
*/
public void setLightTimeCorrection(final boolean lightTimeCorrection) {
this.lightTimeCorrection = lightTimeCorrection;
@@ -278,7 +279,7 @@ public class Rugged {
* @param aberrationOfLightCorrection if true, the aberration of light
* is corrected for more accurate localization
* @see #isAberrationOfLightCorrected()
- * @see #setLineSensor(String, List, LineDatation)
+ * @see #setLightTimeCorrection(boolean)
*/
public void setAberrationOfLightCorrection(final boolean aberrationOfLightCorrection) {
this.aberrationOfLightCorrection = aberrationOfLightCorrection;
--
GitLab