From c2120f0e4bade8afa963f85cbee81badc029fdcf Mon Sep 17 00:00:00 2001
From: Guylaine Prat <guylaine.prat@c-s.fr>
Date: Fri, 27 Oct 2017 10:43:03 +0200
Subject: [PATCH] Javadoc corrections
---
.../org/orekit/rugged/adjustment/AdjustmentContext.java | 4 ++--
src/main/java/org/orekit/rugged/api/Rugged.java | 4 ++--
src/main/java/org/orekit/rugged/api/RuggedBuilder.java | 2 +-
.../rugged/intersection/duvenhage/MinMaxTreeTile.java | 9 ++++-----
.../rugged/refining/measures/SensorToSensorMapping.java | 2 +-
.../orekit/rugged/utils/SpacecraftToObservedBody.java | 2 +-
6 files changed, 11 insertions(+), 12 deletions(-)
diff --git a/src/main/java/org/orekit/rugged/adjustment/AdjustmentContext.java b/src/main/java/org/orekit/rugged/adjustment/AdjustmentContext.java
index 5a3af203..cd8bf214 100644
--- a/src/main/java/org/orekit/rugged/adjustment/AdjustmentContext.java
+++ b/src/main/java/org/orekit/rugged/adjustment/AdjustmentContext.java
@@ -90,10 +90,10 @@ public class AdjustmentContext {
* {@link LineSensor#getParametersDrivers() getParametersDrivers()} method
* on the desired sensors must be configured. The parameters that should be
* estimated must have their {@link ParameterDriver#setSelected(boolean)
- * selection status} set to {@link true} whereas the parameters that should
+ * selection status} set to {@code true} whereas the parameters that should
* retain their current value must have their
* {@link ParameterDriver#setSelected(boolean) selection status} set to
- * {@link false}. If needed, the {@link ParameterDriver#setValue(double)
+ * {@code false}. If needed, the {@link ParameterDriver#setValue(double)
* value} of the estimated/selected parameters can also be changed before
* calling the method, as this value will serve as the initial value in the
* estimation process.
diff --git a/src/main/java/org/orekit/rugged/api/Rugged.java b/src/main/java/org/orekit/rugged/api/Rugged.java
index e7d2b465..aeb95d14 100644
--- a/src/main/java/org/orekit/rugged/api/Rugged.java
+++ b/src/main/java/org/orekit/rugged/api/Rugged.java
@@ -622,7 +622,7 @@ public class Rugged {
* @param dateB current date for sensor B
* @param pixelB pixel index for sensor B
* @return distances computed between LOS and to the ground
- * @exception RuggedException
+ * @exception RuggedException if frames cannot be computed at date or if date cannot be handled
* @since 2.0
*/
public double[] distanceBetweenLOS(final LineSensor sensorA, final AbsoluteDate dateA, final double pixelA,
@@ -695,7 +695,7 @@ public class Rugged {
* @param pixelB pixel index for sensor B
* @param generator generator to use for building {@link DerivativeStructure} instances
* @return distances computed, with derivatives, between LOS and to the ground
- * @exception RuggedException
+ * @exception RuggedException if frames cannot be computed at date
* @see #distanceBetweenLOS(LineSensor, AbsoluteDate, double, SpacecraftToObservedBody, LineSensor, AbsoluteDate, double)
*/
public DerivativeStructure[] distanceBetweenLOSDerivatives(
diff --git a/src/main/java/org/orekit/rugged/api/RuggedBuilder.java b/src/main/java/org/orekit/rugged/api/RuggedBuilder.java
index 66f2fad2..a425d598 100644
--- a/src/main/java/org/orekit/rugged/api/RuggedBuilder.java
+++ b/src/main/java/org/orekit/rugged/api/RuggedBuilder.java
@@ -256,7 +256,7 @@ public class RuggedBuilder {
* IGNORE_DEM_USE_ELLIPSOID} does not require
* any methods tobe called.</li>
* </ul>
- * </p>
+ *
* @param algorithmID identifier of algorithm to use for Digital Elevation Model intersection
* @return the builder instance
* @see #setDigitalElevationModel(TileUpdater, int)
diff --git a/src/main/java/org/orekit/rugged/intersection/duvenhage/MinMaxTreeTile.java b/src/main/java/org/orekit/rugged/intersection/duvenhage/MinMaxTreeTile.java
index cbf5a47a..02c1fdc9 100644
--- a/src/main/java/org/orekit/rugged/intersection/duvenhage/MinMaxTreeTile.java
+++ b/src/main/java/org/orekit/rugged/intersection/duvenhage/MinMaxTreeTile.java
@@ -53,7 +53,7 @@ import org.orekit.rugged.utils.Selector;
* If we consider for example a tall 107 ⨉ 19 raw tile, the min/max kd-tree will
* have 9 levels:
* </p>
- * <p>
+ *
* <table border="0">
* <tr BGCOLOR="#EEEEFF">
* <td>Level</td> <td>Number of sub-tiles</td> <td>Regular sub-tiles dimension</td></tr>
@@ -67,8 +67,7 @@ import org.orekit.rugged.utils.Selector;
* <tr> <td align="center">1</td> <td align="center"> 7 ⨉ 2</td> <td align="center">16 ⨉ 16</td>
* <tr> <td align="center">0</td> <td align="center"> 7 ⨉ 1</td> <td align="center">16 ⨉ 32</td>
* </table>
- * </p>
-
+ * <p>
* @see MinMaxTreeTileFactory
* @author Luc Maisonobe
*/
@@ -154,7 +153,7 @@ public class MinMaxTreeTile extends SimpleTile {
* tree level l includes cell (i,j) but not cell (i+1, j+1). In other words,
* interpolation implies sub-tile boundaries are overshoot by one column to
* the East and one row to the North when computing min.
- * </p>
+ *
* @param i row index of the cell
* @param j column index of the cell
* @param level tree level
@@ -214,7 +213,7 @@ public class MinMaxTreeTile extends SimpleTile {
* tree level l includes cell (i,j) but not cell (i+1, j+1). In other words,
* interpolation implies sub-tile boundaries are overshoot by one column to
* the East and one row to the North when computing max.
- * </p>
+ *
* @param i row index of the cell
* @param j column index of the cell
* @param level tree level
diff --git a/src/main/java/org/orekit/rugged/refining/measures/SensorToSensorMapping.java b/src/main/java/org/orekit/rugged/refining/measures/SensorToSensorMapping.java
index e1790e92..efe85913 100644
--- a/src/main/java/org/orekit/rugged/refining/measures/SensorToSensorMapping.java
+++ b/src/main/java/org/orekit/rugged/refining/measures/SensorToSensorMapping.java
@@ -28,7 +28,7 @@ import org.orekit.time.AbsoluteDate;
/** Container for mapping sensors pixels of two viewing models.
* Store the distance between both lines of sight computed with
- * {@link Rugged#distanceBetweenLOS(LineSensor, AbsoluteDate, double, SpacecraftToObservedBody, LineSensor, AbsoluteDate, double)}
+ * {@link org.orekit.rugged.api.Rugged#distanceBetweenLOS(LineSensor, AbsoluteDate, double, SpacecraftToObservedBody, LineSensor, AbsoluteDate, double)}
* <p> Constraints in relation to Earth distance can be added.
* @see SensorMapping
* @author Lucie LabatAllee
diff --git a/src/main/java/org/orekit/rugged/utils/SpacecraftToObservedBody.java b/src/main/java/org/orekit/rugged/utils/SpacecraftToObservedBody.java
index 1e1e2204..75ef6212 100644
--- a/src/main/java/org/orekit/rugged/utils/SpacecraftToObservedBody.java
+++ b/src/main/java/org/orekit/rugged/utils/SpacecraftToObservedBody.java
@@ -262,7 +262,7 @@ public class SpacecraftToObservedBody implements Serializable {
/** Get transform from spacecraft to inertial frame.
* @param date date of the transform
* @return transform from spacecraft to inertial frame
- * @exception RuggedException if spacecraft position or attitude cannot be computed at date
+ * @exception RuggedException if frames cannot be computed at date
*/
public Transform getScToInertial(final AbsoluteDate date)
throws RuggedException {
--
GitLab