Fixed documentation.

Fixes #916 #920 #923

README.md

@@ -11,8 +11,8 @@ elements (orbits, dates, attitude, frames, ...) and various algorithms to
 handle them (conversions, propagations, pointing, events detection, orbit determination ...).
 
 [![](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
-[![](https://sonar.orekit.org/api/project_badges/measure?project=orekit%3Aorekit&metric=alert_status)](https://sonar.orekit.org/dashboard?id=org.orekit%3Aorekit)
-[![](https://sonar.orekit.org/api/project_badges/measure?project=orekit%3Aorekit&metric=coverage)](https://sonar.orekit.org/dashboard?id=org.orekit%3Aorekit)
+[![](https://sonar.orekit.org/api/project_badges/measure?project=orekit%3Aorekit&metric=alert_status)](https://sonar.orekit.org/dashboard?id=orekit%3Aorekit)
+[![](https://sonar.orekit.org/api/project_badges/measure?project=orekit%3Aorekit&metric=coverage)](https://sonar.orekit.org/dashboard?id=orekit%3Aorekit)
 
 ## Download
 

src/main/java/org/orekit/estimation/iod/IodGibbs.java

@@ -61,7 +61,8 @@ public class IodGibbs {
      * @param p1 First position measurement
      * @param p2 Second position measurement
      * @param p3 Third position measurement
-     * @return an initial orbit estimation
+     * @return an initial orbit estimation at the central date
+     *         (i.e., date of the second position measurement)
      * @since 11.0
      */
     public KeplerianOrbit estimate(final Frame frame, final Position p1, final Position p2, final Position p3) {
@@ -78,7 +79,8 @@ public class IodGibbs {
      * @param pv1 PV measure 1 taken in frame
      * @param pv2 PV measure 2 taken in frame
      * @param pv3 PV measure 3 taken in frame
-     * @return an initial orbit estimation
+     * @return an initial orbit estimation at the central date
+     *         (i.e., date of the second PV measurement)
      */
     public KeplerianOrbit estimate(final Frame frame, final PV pv1, final PV pv2, final PV pv3) {
         return estimate(frame,
@@ -97,7 +99,8 @@ public class IodGibbs {
      * @param date2 date of measure 2
      * @param r3 position 3 measured in frame
      * @param date3 date of measure 3
-     * @return an initial orbit estimation
+     * @return an initial orbit estimation at the central date
+     *         (i.e., date of the second position measurement)
      */
     public KeplerianOrbit estimate(final Frame frame,
                                    final Vector3D r1, final AbsoluteDate date1,

src/main/java/org/orekit/estimation/iod/IodGooding.java

@@ -131,7 +131,8 @@ public class IodGooding {
      * @param rho3init initial guess of the range problem. range 3, in meters
      * @param nRev number of complete revolutions between observation 1 and 3
      * @param direction true if posigrade (short way)
-     * @return an estimate of the Keplerian orbit
+     * @return an estimate of the Keplerian orbit at the central date
+     *         (i.e., date of the second angular observation)
      * @since 11.0
      */
     public KeplerianOrbit estimate(final Frame frame, final AngularRaDec raDec1,
@@ -155,7 +156,8 @@ public class IodGooding {
      * @param raDec3 third angular observation
      * @param rho1init initial guess of the range problem. range 1, in meters
      * @param rho3init initial guess of the range problem. range 3, in meters
-     * @return an estimate of the Keplerian orbit
+     * @return an estimate of the Keplerian orbit at the central date
+     *         (i.e., date of the second angular observation)
      * @since 11.0
      */
     public KeplerianOrbit estimate(final Frame frame, final AngularRaDec raDec1,
@@ -179,7 +181,8 @@ public class IodGooding {
      * @param rho3init initial guess of the range problem. range 3, in meters
      * @param nRev number of complete revolutions between observation1  and 3
      * @param direction true if posigrade (short way)
-     * @return an estimate of the Keplerian orbit
+     * @return an estimate of the Keplerian orbit at the central date
+     *         (i.e., date of the second angular observation)
      */
     public KeplerianOrbit estimate(final Frame frame, final Vector3D O1, final Vector3D O2, final Vector3D O3,
                                    final Vector3D lineOfSight1, final AbsoluteDate dateObs1,
@@ -235,7 +238,8 @@ public class IodGooding {
      * @param dateObs3 date of observation 1
      * @param rho1init initial guess of the range problem. range 1, in meters
      * @param rho3init initial guess of the range problem. range 3, in meters
-     * @return an estimate of the Keplerian orbit
+     * @return an estimate of the Keplerian orbit at the central date
+     *         (i.e., date of the second angular observation)
      */
     public KeplerianOrbit estimate(final Frame frame, final Vector3D O1, final Vector3D O2, final Vector3D O3,
                                    final Vector3D lineOfSight1, final AbsoluteDate dateObs1,

src/main/java/org/orekit/estimation/iod/IodLambert.java

@@ -78,7 +78,7 @@ public class IodLambert {
      * @param nRev      number of revolutions
      * @param p1        first position measurement
      * @param p2        second position measurement
-     * @return an initial orbit estimation
+     * @return an initial Keplerian orbit estimation at the first observation date t1
      * @since 11.0
      */
     public KeplerianOrbit estimate(final Frame frame, final boolean posigrade,
@@ -117,7 +117,7 @@ public class IodLambert {
      * @param t1        date of observation 1
      * @param p2        position vector 2
      * @param t2        date of observation 2
-     * @return  an initial Keplerian orbit estimate
+     * @return  an initial Keplerian orbit estimate at the first observation date t1
      */
     public KeplerianOrbit estimate(final Frame frame, final boolean posigrade,
                                    final int nRev,

src/main/java/org/orekit/estimation/iod/IodLaplace.java

@@ -60,7 +60,7 @@ public class IodLaplace {
      * @param raDec1 first angular observation
      * @param raDec2 second angular observation
      * @param raDec3 third angular observation
-     * @return estimate of the orbit at the central date or null if
+     * @return estimate of the orbit at the central date obsDate2 or null if
      *         no estimate is possible with the given data
      * @since 11.0
      */
@@ -83,7 +83,7 @@ public class IodLaplace {
      * @param los2 line of sight unit vector 2
      * @param obsDate3 date of observation 3
      * @param los3 line of sight unit vector 3
-     * @return estimate of the orbit at the central date dateObs2 or null if
+     * @return estimate of the orbit at the central date obsDate2 or null if
      *         no estimate is possible with the given data
      */
     public CartesianOrbit estimate(final Frame frame, final PVCoordinates obsPva,

src/main/java/org/orekit/propagation/numerical/FieldNumericalPropagator.java

@@ -588,7 +588,7 @@ public class FieldNumericalPropagator<T extends CalculusFieldElement<T>> extends
      * Considering the energy conservation equation V = sqrt(mu (2/r - 1/a)),
      * we get at constant energy (i.e. on a Keplerian trajectory):
      * <pre>
-     * V² r |dV| = mu |dr|
+     * V r² |dV| = mu |dr|
      * </pre>
      * So we deduce a scalar velocity error consistent with the position error.
      * From here, we apply orbits Jacobians matrices to get consistent errors

src/main/java/org/orekit/propagation/numerical/NumericalPropagator.java

@@ -995,7 +995,7 @@ public class NumericalPropagator extends AbstractIntegratedPropagator {
      * Considering the energy conservation equation V = sqrt(mu (2/r - 1/a)),
      * we get at constant energy (i.e. on a Keplerian trajectory):
      * <pre>
-     * V² r |dV| = mu |dr|
+     * V r² |dV| = mu |dr|
      * </pre>
      * <p> So we deduce a scalar velocity error consistent with the position error.
      * From here, we apply orbits Jacobians matrices to get consistent errors

src/main/java/org/orekit/propagation/semianalytical/dsst/DSSTPropagator.java

@@ -1183,7 +1183,7 @@ public class DSSTPropagator extends AbstractIntegratedPropagator {
      *  we get at constant energy (i.e. on a Keplerian trajectory):
      *
      *  <pre>
-     *  V² r |dV| = mu |dr|
+     *  V r² |dV| = mu |dr|
      *  </pre>
      *
      *  <p> So we deduce a scalar velocity error consistent with the position error. From here, we apply

src/main/java/org/orekit/propagation/semianalytical/dsst/FieldDSSTPropagator.java

@@ -1067,7 +1067,7 @@ public class FieldDSSTPropagator<T extends CalculusFieldElement<T>> extends Fiel
      *  we get at constant energy (i.e. on a Keplerian trajectory):
      *
      *  <pre>
-     *  V² r |dV| = mu |dr|
+     *  V r² |dV| = mu |dr|
      *  </pre>
      *
      *  <p> So we deduce a scalar velocity error consistent with the position error. From here, we apply