diff --git a/pom.xml b/pom.xml index b14e947d7ad6ec1dcac6edb25274e5c3ecb82347..d2fd4ae8341668878529a723be7a884bf3a9ab3b 100644 --- a/pom.xml +++ b/pom.xml @@ -416,6 +416,15 @@ <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>${orekit.maven-javadoc-plugin.version}</version> + <configuration> + <overview>${basedir}/src/main/java/org/orekit/overview.html</overview> + <bottom><![CDATA[Copyright © ${project.inceptionYear}-{currentYear} <a href="http://www.c-s.fr">CS Systèmes d'information</a>. All rights reserved.]]></bottom> + <links> + <link>http://docs.oracle.com/javase/8/docs/api/</link> + <link>https://www.hipparchus.org/apidocs/</link> + </links> + <source>${orekit.compiler.source}</source> + </configuration> </plugin> <plugin> <groupId>org.jacoco</groupId> @@ -648,6 +657,7 @@ <link>http://docs.oracle.com/javase/8/docs/api/</link> <link>https://www.hipparchus.org/apidocs/</link> </links> + <source>${orekit.compiler.source}</source> </configuration> <reportSets> <reportSet> diff --git a/src/main/java/org/orekit/bodies/OneAxisEllipsoid.java b/src/main/java/org/orekit/bodies/OneAxisEllipsoid.java index 85487a892927b39c9e87c68896a47a38b9ffa785..e1bfefe180cc07e82bab226c63ba8cd9469ee172 100644 --- a/src/main/java/org/orekit/bodies/OneAxisEllipsoid.java +++ b/src/main/java/org/orekit/bodies/OneAxisEllipsoid.java @@ -79,7 +79,7 @@ public class OneAxisEllipsoid extends Ellipsoid implements BodyShape { /** Simple constructor. * <p>Standard values for Earth models can be found in the {@link org.orekit.utils.Constants Constants} class:</p> - * <table border="1" cellpadding="5" style="background-color:#f5f5dc;"> + * <table border="1" cellpadding="5" style="background-color:#f5f5dc;" summary=""> * <caption>Ellipsoid Models</caption> * <tr style="background-color:#c9d5c9;"><th>model</th><th>a<sub>e</sub> (m)</th> <th>f</th></tr> * <tr><td style="background-color:#c9d5c9;">GRS 80</td> @@ -88,7 +88,7 @@ public class OneAxisEllipsoid extends Ellipsoid implements BodyShape { * <tr><td style="background-color:#c9d5c9;">WGS84</td> * <td>{@link org.orekit.utils.Constants#WGS84_EARTH_EQUATORIAL_RADIUS Constants.WGS84_EARTH_EQUATORIAL_RADIUS}</td> * <td>{@link org.orekit.utils.Constants#WGS84_EARTH_FLATTENING Constants.WGS84_EARTH_FLATTENING}</td></tr> - * </table summary=""> + * </table> * @param ae equatorial radius * @param f the flattening (f = (a-b)/a) * @param bodyFrame body frame related to body shape @@ -215,7 +215,21 @@ public class OneAxisEllipsoid extends Ellipsoid implements BodyShape { } - /** {@inheritDoc} */ + /** Get the intersection point of a line with the surface of the body. + * <p>A line may have several intersection points with a closed + * surface (we consider the one point case as a degenerated two + * points case). The close parameter is used to select which of + * these points should be returned. The selected point is the one + * that is closest to the close point.</p> + * @param line test line (may intersect the body or not) + * @param close point used for intersections selection + * @param frame frame in which line is expressed + * @param date date of the line in given frame + * @param <T> type of the field elements + * @return intersection point at altitude zero or null if the line does + * not intersect the surface + * @since 9.3 + */ public <T extends RealFieldElement<T>> FieldVector3D<T> getCartesianIntersectionPoint(final FieldLine<T> line, final FieldVector3D<T> close, final Frame frame, diff --git a/src/main/java/org/orekit/estimation/measurements/AngularAzEl.java b/src/main/java/org/orekit/estimation/measurements/AngularAzEl.java index 119742699ac9adb14243c6b7aad9aeb20ad17961..320db24dcbd7d4f929dd4b17301db91f11b21ffc 100644 --- a/src/main/java/org/orekit/estimation/measurements/AngularAzEl.java +++ b/src/main/java/org/orekit/estimation/measurements/AngularAzEl.java @@ -57,7 +57,7 @@ public class AngularAzEl extends AbstractMeasurement<AngularAzEl> { * @param angular observed value * @param sigma theoretical standard deviation * @param baseWeight base weight - * @deprecated since 9.3, replaced by {@#AngularAzEl(GroundStation, AbsoluteDate, + * @deprecated since 9.3, replaced by {@link #AngularAzEl(GroundStation, AbsoluteDate, * double[], double[], double[], ObservableSatellite)} */ @Deprecated @@ -74,7 +74,7 @@ public class AngularAzEl extends AbstractMeasurement<AngularAzEl> { * @param baseWeight base weight * @param propagatorIndex index of the propagator related to this measurement * @since 9.0 - * @deprecated since 9.3, replaced by {@#AngularAzEl(GroundStation, AbsoluteDate, + * @deprecated since 9.3, replaced by {@link #AngularAzEl(GroundStation, AbsoluteDate, * double[], double[], double[], ObservableSatellite)} */ @Deprecated diff --git a/src/main/java/org/orekit/estimation/measurements/AngularRaDec.java b/src/main/java/org/orekit/estimation/measurements/AngularRaDec.java index fd5860b191f48f4f0910cf3cf8f28a2e4dfa4bcf..5c07faac59134d63ebffbc6824d333d27f517abc 100644 --- a/src/main/java/org/orekit/estimation/measurements/AngularRaDec.java +++ b/src/main/java/org/orekit/estimation/measurements/AngularRaDec.java @@ -64,7 +64,7 @@ public class AngularRaDec extends AbstractMeasurement<AngularRaDec> { * @param angular observed value * @param sigma theoretical standard deviation * @param baseWeight base weight - * @deprecated since 9.3, replaced by {@#AngularRaDec(GroundStation, AbsoluteDate, + * @deprecated since 9.3, replaced by {@link #AngularRaDec(GroundStation, Frame, AbsoluteDate, * double[], double[], double[], ObservableSatellite)} */ @Deprecated @@ -82,7 +82,7 @@ public class AngularRaDec extends AbstractMeasurement<AngularRaDec> { * @param baseWeight base weight * @param propagatorIndex index of the propagator related to this measurement * @since 9.0 - * @deprecated since 9.3, replaced by {@#AngularRaDec(GroundStation, AbsoluteDate, + * @deprecated since 9.3, replaced by {@link #AngularRaDec(GroundStation, Frame, AbsoluteDate, * double[], double[], double[], ObservableSatellite)} */ @Deprecated diff --git a/src/main/java/org/orekit/estimation/measurements/ComparableMeasurement.java b/src/main/java/org/orekit/estimation/measurements/ComparableMeasurement.java index 533ef3c1788e75c77a662bd4a28a877962869116..5539e04fe80aefccca7d4896528bf18cc5f89850 100644 --- a/src/main/java/org/orekit/estimation/measurements/ComparableMeasurement.java +++ b/src/main/java/org/orekit/estimation/measurements/ComparableMeasurement.java @@ -29,7 +29,7 @@ public interface ComparableMeasurement extends TimeStamped, Comparable<Comparabl * <p> * The observed value is the value that was measured by the instrument. * </p> - * @return observed value (array of size {@link #getDimension()} + * @return observed value */ double[] getObservedValue(); diff --git a/src/main/java/org/orekit/estimation/measurements/PV.java b/src/main/java/org/orekit/estimation/measurements/PV.java index cb0215514d7400dfe148d6f8e34ef63ca36d3ce8..3b18663416d7ff7e3ef6c5a47c4bfff4ca16f401 100644 --- a/src/main/java/org/orekit/estimation/measurements/PV.java +++ b/src/main/java/org/orekit/estimation/measurements/PV.java @@ -345,7 +345,7 @@ public class PV extends AbstractMeasurement<PV> { * @param baseWeight base weight * @since 9.2 * @deprecated as of 9.3, replaced by {@link #PV(AbsoluteDate, Vector3D, Vector3D, - * double[][], double, ObservableSatellite))} + * double[][], double, ObservableSatellite)} */ @Deprecated public PV(final AbsoluteDate date, final Vector3D position, final Vector3D velocity, @@ -364,7 +364,7 @@ public class PV extends AbstractMeasurement<PV> { * @param propagatorIndex index of the propagator related to this measurement * @since 9.2 * @deprecated as of 9.3, replaced by {@link #PV(AbsoluteDate, Vector3D, Vector3D, - * double[][], double, ObservableSatellite))} + * double[][], double, ObservableSatellite)} */ @Deprecated public PV(final AbsoluteDate date, final Vector3D position, final Vector3D velocity, diff --git a/src/main/java/org/orekit/estimation/measurements/generation/Generator.java b/src/main/java/org/orekit/estimation/measurements/generation/Generator.java index 3071dcadf3b3a86e3b7d3cff396e6f2c7ce11fc6..a927009f13bca99cc2c39f8e067d1651ee1f5442 100644 --- a/src/main/java/org/orekit/estimation/measurements/generation/Generator.java +++ b/src/main/java/org/orekit/estimation/measurements/generation/Generator.java @@ -31,7 +31,7 @@ import org.orekit.propagation.sampling.OrekitStepInterpolator; import org.orekit.time.AbsoluteDate; -/** Main generator for {@link ObservedMeasurements observed measurements}. +/** Main generator for {@link ObservedMeasurement observed measurements}. * @author Luc Maisonobe * @since 9.3 */ diff --git a/src/main/java/org/orekit/estimation/measurements/generation/MeasurementBuilder.java b/src/main/java/org/orekit/estimation/measurements/generation/MeasurementBuilder.java index c4c619f884ebca5fac5b479e36cc228302c4b02a..2713ae2bef27fac457b5678ee21ac0c046cffdec 100644 --- a/src/main/java/org/orekit/estimation/measurements/generation/MeasurementBuilder.java +++ b/src/main/java/org/orekit/estimation/measurements/generation/MeasurementBuilder.java @@ -24,7 +24,7 @@ import org.orekit.propagation.SpacecraftState; import org.orekit.time.AbsoluteDate; -/** Interface for generating individual {@link ObservedMeasurements measurements}. +/** Interface for generating individual {@link ObservedMeasurement measurements}. * @param <T> the type of the measurement * @author Luc Maisonobe * @since 9.3 diff --git a/src/main/java/org/orekit/estimation/measurements/generation/Scheduler.java b/src/main/java/org/orekit/estimation/measurements/generation/Scheduler.java index a81f1dd3742a8f75ba39f934536f5991a89ac0eb..280760af7197436a9c27835fb39a929d4bb707d4 100644 --- a/src/main/java/org/orekit/estimation/measurements/generation/Scheduler.java +++ b/src/main/java/org/orekit/estimation/measurements/generation/Scheduler.java @@ -24,7 +24,7 @@ import org.orekit.propagation.sampling.OrekitStepInterpolator; import org.orekit.time.AbsoluteDate; -/** Interface for generating {@link ObservedMeasurements measurements} sequences. +/** Interface for generating {@link ObservedMeasurement measurements} sequences. * @param <T> the type of the measurement * @author Luc Maisonobe * @since 9.3 diff --git a/src/main/java/org/orekit/estimation/sequential/KalmanEstimatorBuilder.java b/src/main/java/org/orekit/estimation/sequential/KalmanEstimatorBuilder.java index fef334b8212b6a76c5db6b3cf4ed9a805096c1fa..ac449bf9e16f86b31ea547b94cdcac856658b92c 100644 --- a/src/main/java/org/orekit/estimation/sequential/KalmanEstimatorBuilder.java +++ b/src/main/java/org/orekit/estimation/sequential/KalmanEstimatorBuilder.java @@ -21,7 +21,6 @@ import java.util.List; import org.hipparchus.linear.MatrixDecomposer; import org.hipparchus.linear.QRDecomposer; -import org.hipparchus.linear.RealMatrix; import org.orekit.errors.OrekitException; import org.orekit.errors.OrekitMessages; import org.orekit.propagation.conversion.NumericalPropagatorBuilder; @@ -56,15 +55,13 @@ public class KalmanEstimatorBuilder { this.processNoiseMatricesProviders = new ArrayList<>(); } - /** Construct a {@link KalmanEstimatorReal} from the data in this builder. + /** Construct a {@link KalmanEstimator} from the data in this builder. * <p> * Before this method is called, {@link #addPropagationConfiguration(NumericalPropagatorBuilder, - * ProcessNoiseMatrixProvider)addPropagationConfiguration()} must have been called - * at least once and {@link #initialCovarianceMatrix(RealMatrix) initialCovarianceMatrix()} - * must have been called, otherwise configuration is incomplete and an exception - * will be raised. + * CovarianceMatrixProvider) addPropagationConfiguration()} must have been called + * at least once, otherwise configuration is incomplete and an exception will be raised. * </p> - * @return a new {@link KalmanEstimatorReal}. + * @return a new {@link KalmanEstimator}. */ public KalmanEstimator build() { final int n = propagatorBuilders.size(); @@ -92,7 +89,7 @@ public class KalmanEstimatorBuilder { * </p> * <p> * The {@code provider} should return a matrix with dimensions and ordering - * consistent with the {@link builder} configuration. The first 6 rows/columns + * consistent with the {@code builder} configuration. The first 6 rows/columns * correspond to the 6 orbital parameters which must all be present, regardless * of the fact they are estimated or not. The remaining elements correspond * to the subset of propagation parameters that are estimated, in the diff --git a/src/main/java/org/orekit/estimation/sequential/UnivariateProcessNoise.java b/src/main/java/org/orekit/estimation/sequential/UnivariateProcessNoise.java index 43cb50f03d10741f10d60e3b119743441b261235..8ffa4f0e15552d65584c08c28092b4c10c2c79e7 100644 --- a/src/main/java/org/orekit/estimation/sequential/UnivariateProcessNoise.java +++ b/src/main/java/org/orekit/estimation/sequential/UnivariateProcessNoise.java @@ -34,7 +34,7 @@ import org.orekit.propagation.SpacecraftState; * The method {@link #getProcessNoiseMatrix} then square the values so that they are consistent with a covariance matrix. * <p> * The orbital parameters evolutions are provided in LOF frame and Cartesian (PV); - * then converted in inertial frame and current {@link OrbitType} and {@link PositionAngle} + * then converted in inertial frame and current {@link org.orekit.orbits.OrbitType} and {@link PositionAngle} * when method {@link #getProcessNoiseMatrix} is called. * </p> * <p> diff --git a/src/main/java/org/orekit/files/ccsds/Keyword.java b/src/main/java/org/orekit/files/ccsds/Keyword.java index ee7a2bfc03d3f31db8101708107a73719e188df0..80032698fe8d8535dc202bd1a6946cc8b084ee25 100644 --- a/src/main/java/org/orekit/files/ccsds/Keyword.java +++ b/src/main/java/org/orekit/files/ccsds/Keyword.java @@ -504,7 +504,7 @@ public enum Keyword { /** Data: ANGLE_1 in degrees and in [-180, +360[ [deg].<p> * The value assigned to the ANGLE_1 keyword represents the azimuth, right ascension, or ‘X’ * angle of the measurement, depending on the value of the ANGLE_TYPE keyword.<p> - * The angle measurement shall be a double precision value as follows: -180.0 <= ANGLE_1 < 360.0<p> + * The angle measurement shall be a double precision value as follows: -180.0 ≤ ANGLE_1 < 360.0<p> * Units shall be degrees.<p> * See meta-data keyword ANGLE_TYPE for the definition of the angles. */ @@ -512,7 +512,7 @@ public enum Keyword { /** Data: ANGLE_2 in degrees and in [-180, +360[ [deg].<p> * The value assigned to the ANGLE_2 keyword represents the elevation, declination, or ‘Y’ * angle of the measurement, depending on the value of the ANGLE_TYPE keyword.<p> - * The angle measurement shall be a double precision value as follows: -180.0 <= ANGLE_2 < 360.0.<p> + * The angle measurement shall be a double precision value as follows: -180.0 ≤ ANGLE_2 < 360.0.<p> * Units shall be degrees.<p> * See meta-data keyword ANGLE_TYPE for the definition of the angles. */ diff --git a/src/main/java/org/orekit/forces/drag/atmosphere/JB2008.java b/src/main/java/org/orekit/forces/drag/atmosphere/JB2008.java index 81e92fa1bafdb83f56aa4b270d11df9b9f79aed4..0d9e2985981a7a0e2a46acaf4bf23a91488d530e 100644 --- a/src/main/java/org/orekit/forces/drag/atmosphere/JB2008.java +++ b/src/main/java/org/orekit/forces/drag/atmosphere/JB2008.java @@ -39,7 +39,7 @@ import org.orekit.utils.PVCoordinatesProvider; * It is described in the paper:<br> * <a href="http://sol.spacenvironment.net/~JB2008/pubs/AIAA_2008-6438_JB2008_Model.pdf">A * New Empirical Thermospheric Density Model JB2008 Using New Solar Indices</a><br> - * <i>Bruce R. Bowman & al.</i><br> + * <i>Bruce R. Bowman & al.</i><br> * AIAA 2008-6438<br> * </p> * <p> @@ -209,9 +209,9 @@ public class JB2008 implements Atmosphere { * (Tabular time 2.0 days earlier) * @param xm10B MG2 81-day ave. centered index<br> * (Tabular time 2.0 days earlier) - * @param y10 Solar X-Ray & Lya index scaled to F10<br> + * @param y10 Solar X-Ray & Lya index scaled to F10<br> * (Tabular time 5.0 days earlier) - * @param y10B Solar X-Ray & Lya 81-day ave. centered index<br> + * @param y10B Solar X-Ray & Lya 81-day ave. centered index<br> * (Tabular time 5.0 days earlier) * @param dstdtc Temperature change computed from Dst index * @return total mass-Density at input position (kg/m³) @@ -469,9 +469,9 @@ public class JB2008 implements Atmosphere { * (Tabular time 2.0 days earlier) * @param xm10B MG2 81-day ave. centered index<br> * (Tabular time 2.0 days earlier) - * @param y10 Solar X-Ray & Lya index scaled to F10<br> + * @param y10 Solar X-Ray & Lya index scaled to F10<br> * (Tabular time 5.0 days earlier) - * @param y10B Solar X-Ray & Lya 81-day ave. centered index<br> + * @param y10B Solar X-Ray & Lya 81-day ave. centered index<br> * (Tabular time 5.0 days earlier) * @param dstdtc Temperature change computed from Dst index * @param <T> type fo the field elements diff --git a/src/main/java/org/orekit/forces/drag/atmosphere/JB2008InputParameters.java b/src/main/java/org/orekit/forces/drag/atmosphere/JB2008InputParameters.java index 5cd28bb9966f1915e88f84806ab06de9fb9e4bcc..89bda5a2332f774a81cda84e764ec0212d90936b 100644 --- a/src/main/java/org/orekit/forces/drag/atmosphere/JB2008InputParameters.java +++ b/src/main/java/org/orekit/forces/drag/atmosphere/JB2008InputParameters.java @@ -81,17 +81,17 @@ public interface JB2008InputParameters extends Serializable { */ double getXM10B(AbsoluteDate date); - /** Get the Solar X-Ray & Lya index scaled to F10. + /** Get the Solar X-Ray & Lya index scaled to F10. * <p>Tabular time 5.0 days earlier.</p> * @param date the current date - * @return the Solar X-Ray & Lya index scaled to F10 + * @return the Solar X-Ray & Lya index scaled to F10 */ double getY10(AbsoluteDate date); - /** Get the Solar X-Ray & Lya 81-day ave. centered index. + /** Get the Solar X-Ray & Lya 81-day ave. centered index. * <p>Tabular time 5.0 days earlier.</p> * @param date the current date - * @return the Solar X-Ray & Lya 81-day ave. centered index + * @return the Solar X-Ray & Lya 81-day ave. centered index */ double getY10B(AbsoluteDate date); diff --git a/src/main/java/org/orekit/forces/drag/atmosphere/NRLMSISE00.java b/src/main/java/org/orekit/forces/drag/atmosphere/NRLMSISE00.java index 8b1725e796d878bdc051c2b266fdc3397eb854b0..8d27ea7bcff3b1bfec6d135f17c16be5432cbc6d 100644 --- a/src/main/java/org/orekit/forces/drag/atmosphere/NRLMSISE00.java +++ b/src/main/java/org/orekit/forces/drag/atmosphere/NRLMSISE00.java @@ -121,7 +121,7 @@ import org.orekit.utils.PVCoordinatesProvider; * Instances of this class are immutable. * </p> * - * @author Mike Picone & al (Naval Research Laboratory), 2001: FORTRAN routine + * @author Mike Picone & al (Naval Research Laboratory), 2001: FORTRAN routine * @author Dominik Brodowski, 2004: C routine * @author Pascal Parraud, 2016: Java translation * @since 8.1 diff --git a/src/main/java/org/orekit/forces/drag/atmosphere/NRLMSISE00InputParameters.java b/src/main/java/org/orekit/forces/drag/atmosphere/NRLMSISE00InputParameters.java index bd0da50e2200f9516c83a018abba195237279a51..ba021b6e9646b5c61fb8965e25c90b75da9734e3 100644 --- a/src/main/java/org/orekit/forces/drag/atmosphere/NRLMSISE00InputParameters.java +++ b/src/main/java/org/orekit/forces/drag/atmosphere/NRLMSISE00InputParameters.java @@ -57,14 +57,14 @@ public interface NRLMSISE00InputParameters extends Serializable { * <p> * A<sub>p</sub> indices are provided as an array such as: * <ul> - * <li>0 -> daily A<sub>p</sub></li> - * <li>1 -> 3 hr A<sub>p</sub> index for current time</li> - * <li>2 -> 3 hr A<sub>p</sub> index for 3 hrs before current time</li> - * <li>3 -> 3 hr A<sub>p</sub> index for 6 hrs before current time</li> - * <li>4 -> 3 hr A<sub>p</sub> index for 9 hrs before current time</li> - * <li>5 -> Average of eight 3 hr A<sub>p</sub> indices from 12 to 33 hrs + * <li>0 → daily A<sub>p</sub></li> + * <li>1 → 3 hr A<sub>p</sub> index for current time</li> + * <li>2 → 3 hr A<sub>p</sub> index for 3 hrs before current time</li> + * <li>3 → 3 hr A<sub>p</sub> index for 6 hrs before current time</li> + * <li>4 → 3 hr A<sub>p</sub> index for 9 hrs before current time</li> + * <li>5 → Average of eight 3 hr A<sub>p</sub> indices from 12 to 33 hrs * prior to current time</li> - * <li>6 -> Average of eight 3 hr A<sub>p</sub> indices from 36 to 57 hrs + * <li>6 → Average of eight 3 hr A<sub>p</sub> indices from 36 to 57 hrs * prior to current time</li> * </ul> * </p> diff --git a/src/main/java/org/orekit/models/earth/DiscreteTroposphericModel.java b/src/main/java/org/orekit/models/earth/DiscreteTroposphericModel.java index 99a8f387bb4464aabff22b11e22bd3a829820396..77b7af9c58434706a8e1860ce748eebabfd6cd02 100644 --- a/src/main/java/org/orekit/models/earth/DiscreteTroposphericModel.java +++ b/src/main/java/org/orekit/models/earth/DiscreteTroposphericModel.java @@ -64,8 +64,8 @@ public interface DiscreteTroposphericModel extends MappingFunction { /** This method allows the computation of the zenith hydrostatic and * zenith wet delay. The resulting element is an array having the following form: * <ul> - * <li>double[0] = D<sub>hz</sub> -> zenith hydrostatic delay - * <li>double[1] = D<sub>wz</sub> -> zenith wet delay + * <li>double[0] = D<sub>hz</sub> → zenith hydrostatic delay + * <li>double[1] = D<sub>wz</sub> → zenith wet delay * </ul> * @param height the height of the station in m above sea level. * @param parameters tropospheric model parameters. @@ -77,8 +77,8 @@ public interface DiscreteTroposphericModel extends MappingFunction { /** This method allows the computation of the zenith hydrostatic and * zenith wet delay. The resulting element is an array having the following form: * <ul> - * <li>T[0] = D<sub>hz</sub> -> zenith hydrostatic delay - * <li>T[1] = D<sub>wz</sub> -> zenith wet delay + * <li>T[0] = D<sub>hz</sub> → zenith hydrostatic delay + * <li>T[1] = D<sub>wz</sub> → zenith wet delay * </ul> * @param <T> type of the elements * @param height the height of the station in m above sea level. diff --git a/src/main/java/org/orekit/models/earth/EstimatedTroposphericModel.java b/src/main/java/org/orekit/models/earth/EstimatedTroposphericModel.java index 6860d35937842fc017b2fa15c95a8683845cd2f4..14dbef7e35790287938b8318a6ac58ea881f7376 100644 --- a/src/main/java/org/orekit/models/earth/EstimatedTroposphericModel.java +++ b/src/main/java/org/orekit/models/earth/EstimatedTroposphericModel.java @@ -141,8 +141,8 @@ public class EstimatedTroposphericModel implements DiscreteTroposphericModel { /** This method allows the computation of the zenith hydrostatic and zenith total delays. * The resulting element is an array having the following form: * <ul> - * <li>double[0] = D<sub>hz</sub> -> zenith hydrostatic delay - * <li>double[1] = D<sub>tz</sub> -> zenith total delay + * <li>double[0] = D<sub>hz</sub> → zenith hydrostatic delay + * <li>double[1] = D<sub>tz</sub> → zenith total delay * </ul> * <p> * The user have to be careful because the others tropospheric models in Orekit @@ -172,8 +172,8 @@ public class EstimatedTroposphericModel implements DiscreteTroposphericModel { /** This method allows the computation of the zenith hydrostatic and zenith total delays. * The resulting element is an array having the following form: * <ul> - * <li>double[0] = D<sub>hz</sub> -> zenith hydrostatic delay - * <li>double[1] = D<sub>tz</sub> -> zenith total delay + * <li>double[0] = D<sub>hz</sub> → zenith hydrostatic delay + * <li>double[1] = D<sub>tz</sub> → zenith total delay * </ul> * <p> * The user have to be careful because the others tropospheric models in Orekit diff --git a/src/main/java/org/orekit/models/earth/GlobalPressureTemperatureModel.java b/src/main/java/org/orekit/models/earth/GlobalPressureTemperatureModel.java index 63aa5e4796d8b1772dfc3a0ade32bca426f585a4..53d0a85f3087c4c141eba5f049467845144e1193 100644 --- a/src/main/java/org/orekit/models/earth/GlobalPressureTemperatureModel.java +++ b/src/main/java/org/orekit/models/earth/GlobalPressureTemperatureModel.java @@ -64,7 +64,7 @@ public class GlobalPressureTemperatureModel implements WeatherModel { /** Build a new instance. * <p> * At the initialization the values of the pressure and the temperature are set to NaN. - * The user has to call {@link #computeTemperatureAndPressure} method before using + * The user has to call {@link #weatherParameters(double, AbsoluteDate)} method before using * the values of the pressure and the temperature. * </p> * @param latitude geodetic latitude, in radians diff --git a/src/main/java/org/orekit/models/earth/MappingFunction.java b/src/main/java/org/orekit/models/earth/MappingFunction.java index 9e765f9c35e24035df0d8fe36d67d048cbed4ab3..5975bef91d768aab73feb91a748e9946513209fb 100644 --- a/src/main/java/org/orekit/models/earth/MappingFunction.java +++ b/src/main/java/org/orekit/models/earth/MappingFunction.java @@ -34,8 +34,8 @@ public interface MappingFunction extends Serializable { /** This method allows the computation of the hydrostatic and * wet mapping functions. The resulting element is an array having the following form: * <ul> - * <li>double[0] = m<sub>h</sub>(e) -> hydrostatic mapping function - * <li>double[1] = m<sub>w</sub>(e) -> wet mapping function + * <li>double[0] = m<sub>h</sub>(e) → hydrostatic mapping function + * <li>double[1] = m<sub>w</sub>(e) → wet mapping function * </ul> * @param elevation the elevation of the satellite, in radians. * @param height the height of the station in m above sea level. @@ -48,8 +48,8 @@ public interface MappingFunction extends Serializable { /** This method allows the computation of the hydrostatic and * wet mapping functions. The resulting element is an array having the following form: * <ul> - * <li>T[0] = m<sub>h</sub>(e) -> hydrostatic mapping function - * <li>T[1] = m<sub>w</sub>(e) -> wet mapping function + * <li>T[0] = m<sub>h</sub>(e) → hydrostatic mapping function + * <li>T[1] = m<sub>w</sub>(e) → wet mapping function * </ul> * @param elevation the elevation of the satellite, in radians. * @param height the height of the station in m above sea level. diff --git a/src/main/java/org/orekit/models/earth/MendesPavlisModel.java b/src/main/java/org/orekit/models/earth/MendesPavlisModel.java index ff29a266fb1f98639a10a1834f381b323c5a0923..d44841a2092df6e9566dc3aa9c24589a4e82e946 100644 --- a/src/main/java/org/orekit/models/earth/MendesPavlisModel.java +++ b/src/main/java/org/orekit/models/earth/MendesPavlisModel.java @@ -83,7 +83,7 @@ public class MendesPavlisModel implements DiscreteTroposphericModel { * thanks to the values of the pressure, the temperature and the humidity * @param t0 the temperature at the station, K * @param p0 the atmospheric pressure at the station, hPa - * @param rh the humidity at the station, percent (50% -> 0.5) + * @param rh the humidity at the station, percent (50% → 0.5) * @param latitude geodetic latitude of the station, radians * @param lambda laser wavelength, µm * */ @@ -225,8 +225,8 @@ public class MendesPavlisModel implements DiscreteTroposphericModel { * Therefore, the two components of the resulting array are * equals. * <ul> - * <li>double[0] = m(e) -> total mapping function - * <li>double[1] = m(e) -> total mapping function + * <li>double[0] = m(e) → total mapping function + * <li>double[1] = m(e) → total mapping function * </ul> * </p><p> * The total delay will thus be computed as this: @@ -365,7 +365,7 @@ public class MendesPavlisModel implements DiscreteTroposphericModel { * * See: Giacomo, P., Equation for the dertermination of the density of moist air, Metrologia, V. 18, 1982 * - * @param rh relative humidity, in percent (50% -> 0.5). + * @param rh relative humidity, in percent (50% → 0.5). * @return the water vapor, in mbar (1 mbar = 1 hPa). */ private double getWaterVapor(final double rh) { diff --git a/src/main/java/org/orekit/models/earth/TroposphericModel.java b/src/main/java/org/orekit/models/earth/TroposphericModel.java index 190e2828c82a705a9a3acfaf497632a3523a446e..119fcefc86b81ef91522afd9b1cd1c953c78580d 100644 --- a/src/main/java/org/orekit/models/earth/TroposphericModel.java +++ b/src/main/java/org/orekit/models/earth/TroposphericModel.java @@ -93,8 +93,8 @@ public interface TroposphericModel extends DiscreteTroposphericModel { /** This method allows the computation of the zenith hydrostatic and * zenith wet delay. The resulting element is an array having the following form: * <ul> - * <li>double[0] = D<sub>hz</sub> -> zenith hydrostatic delay - * <li>double[1] = D<sub>wz</sub> -> zenith wet delay + * <li>double[0] = D<sub>hz</sub> → zenith hydrostatic delay + * <li>double[1] = D<sub>wz</sub> → zenith wet delay * </ul> * @param height the height of the station in m above sea level. * @param parameters tropospheric model parameters. @@ -111,8 +111,8 @@ public interface TroposphericModel extends DiscreteTroposphericModel { /** This method allows the computation of the zenith hydrostatic and * zenith wet delay. The resulting element is an array having the following form: * <ul> - * <li>double[0] = D<sub>hz</sub> -> zenith hydrostatic delay - * <li>double[1] = D<sub>wz</sub> -> zenith wet delay + * <li>double[0] = D<sub>hz</sub> → zenith hydrostatic delay + * <li>double[1] = D<sub>wz</sub> → zenith wet delay * </ul> * @param <T> type of the elements * @param height the height of the station in m above sea level. @@ -132,8 +132,8 @@ public interface TroposphericModel extends DiscreteTroposphericModel { /** This method allows the computation of the hydrostatic and * wet mapping functions. The resulting element is an array having the following form: * <ul> - * <li>double[0] = m<sub>h</sub>(e) -> hydrostatic mapping function - * <li>double[1] = m<sub>w</sub>(e) -> wet mapping function + * <li>double[0] = m<sub>h</sub>(e) → hydrostatic mapping function + * <li>double[1] = m<sub>w</sub>(e) → wet mapping function * </ul> * @param elevation the elevation of the satellite, in radians. * @param height the height of the station in m above sea level. @@ -151,8 +151,8 @@ public interface TroposphericModel extends DiscreteTroposphericModel { /** This method allows the computation of the hydrostatic and * wet mapping functions. The resulting element is an array having the following form: * <ul> - * <li>double[0] = m<sub>h</sub>(e) -> hydrostatic mapping function - * <li>double[1] = m<sub>w</sub>(e) -> wet mapping function + * <li>double[0] = m<sub>h</sub>(e) → hydrostatic mapping function + * <li>double[1] = m<sub>w</sub>(e) → wet mapping function * </ul> * @param elevation the elevation of the satellite, in radians. * @param height the height of the station in m above sea level. diff --git a/src/main/java/org/orekit/models/earth/ViennaModelCoefficientsLoader.java b/src/main/java/org/orekit/models/earth/ViennaModelCoefficientsLoader.java index 3bac36856b0b9e5437ddc01c52d2b7aa80f3463a..101ce77b76fb273df314ed15256a686f49c4d38d 100644 --- a/src/main/java/org/orekit/models/earth/ViennaModelCoefficientsLoader.java +++ b/src/main/java/org/orekit/models/earth/ViennaModelCoefficientsLoader.java @@ -142,8 +142,8 @@ public class ViennaModelCoefficientsLoader implements DataLoader { /** Returns the zenith delay array. * <ul> - * <li>double[0] = D<sub>hz</sub> -> zenith hydrostatic delay - * <li>double[1] = D<sub>wz</sub> -> zenith wet delay + * <li>double[0] = D<sub>hz</sub> → zenith hydrostatic delay + * <li>double[1] = D<sub>wz</sub> → zenith wet delay * </ul> * @return the zenith delay array */ diff --git a/src/main/java/org/orekit/orbits/FieldKeplerianOrbit.java b/src/main/java/org/orekit/orbits/FieldKeplerianOrbit.java index 70c5ade2a96a6c956e5e25ce109b20f8fb1d6692..2129fe4b7b1c8927fa2b8fcb979a4801c171749b 100644 --- a/src/main/java/org/orekit/orbits/FieldKeplerianOrbit.java +++ b/src/main/java/org/orekit/orbits/FieldKeplerianOrbit.java @@ -875,7 +875,7 @@ public class FieldKeplerianOrbit<T extends RealFieldElement<T>> extends FieldOrb * @return position vector * @deprecated as of 9.3 replaced with {@link #FieldKeplerianOrbit(RealFieldElement, RealFieldElement, * RealFieldElement, RealFieldElement, RealFieldElement, RealFieldElement, PositionAngle, Frame, - * FieldAbsoluteDate, double)} and {@#getPVCoordinates()} + * FieldAbsoluteDate, double)} and {@link #getPVCoordinates()} */ @Deprecated public static <T extends RealFieldElement<T>> FieldVector3D<T> ellipticKeplerianToPosition(final T a, final T e, final T i, @@ -925,7 +925,7 @@ public class FieldKeplerianOrbit<T extends RealFieldElement<T>> extends FieldOrb * @return position vector * @deprecated as of 9.3 replaced with {@link #FieldKeplerianOrbit(RealFieldElement, RealFieldElement, * RealFieldElement, RealFieldElement, RealFieldElement, RealFieldElement, PositionAngle, Frame, - * FieldAbsoluteDate, double)} and {@#getPVCoordinates()} + * FieldAbsoluteDate, double)} and {@link #getPVCoordinates()} */ @Deprecated public static <T extends RealFieldElement<T>> FieldVector3D<T> hyperbolicKeplerianToPosition(final T a, final T e, final T i, diff --git a/src/main/java/org/orekit/propagation/PropagatorsParallelizer.java b/src/main/java/org/orekit/propagation/PropagatorsParallelizer.java index 9e9d246e8d22a133bc5d0a8bb66eef7480e91311..c5ec321cc93628e2652c2f1886e5de44ba074197 100644 --- a/src/main/java/org/orekit/propagation/PropagatorsParallelizer.java +++ b/src/main/java/org/orekit/propagation/PropagatorsParallelizer.java @@ -64,15 +64,15 @@ import org.orekit.time.TimeStamped; * simulation times flows from left to right: * </p> * <pre> - * propagator 1 : -------------[++++current step++++]> + * propagator 1 : -------------[++++current step++++]> * | - * propagator 2 : ----[++++current step++++]---------> + * propagator 2 : ----[++++current step++++]---------> * | | * ... | | - * propagator n : ---------[++++current step++++]----> + * propagator n : ---------[++++current step++++]----> * | | * V V - * global handler : -------------[global step]---------> + * global handler : -------------[global step]---------> * </pre> * <p> * The previous sketch shows that propagator 1 has already computed states diff --git a/src/main/java/org/orekit/propagation/analytical/FieldEcksteinHechlerPropagator.java b/src/main/java/org/orekit/propagation/analytical/FieldEcksteinHechlerPropagator.java index 20e4943ffa4ff36d26af045605d71094eb5aacab..f8f3c21e39828a3533c2c8177a01f991099c46c6 100644 --- a/src/main/java/org/orekit/propagation/analytical/FieldEcksteinHechlerPropagator.java +++ b/src/main/java/org/orekit/propagation/analytical/FieldEcksteinHechlerPropagator.java @@ -40,7 +40,7 @@ import org.orekit.utils.TimeStampedFieldPVCoordinates; /** This class propagates a {@link org.orekit.propagation.FieldSpacecraftState} * using the analytical Eckstein-Hechler model. * <p>The Eckstein-Hechler model is suited for near circular orbits - * (e < 0.1, with poor accuracy between 0.005 and 0.1) and inclination + * (e < 0.1, with poor accuracy between 0.005 and 0.1) and inclination * neither equatorial (direct or retrograde) nor critical (direct or * retrograde).</p> * @see FieldOrbit diff --git a/src/main/java/org/orekit/propagation/events/FunctionalDetector.java b/src/main/java/org/orekit/propagation/events/FunctionalDetector.java index 94cf715ac5bc9411542a8424ff10e865e19f1b94..d7964412ade15c43c54f0d6ce497824d3e340b2b 100644 --- a/src/main/java/org/orekit/propagation/events/FunctionalDetector.java +++ b/src/main/java/org/orekit/propagation/events/FunctionalDetector.java @@ -30,7 +30,7 @@ import org.orekit.propagation.events.handlers.EventHandler; * * <code><pre> * FunctionalDetector d = new FunctionalDetector() - * .withGFunction((s)-> s.getDate().durationFrom(triggerDate)) + * .withGFunction((s) -> s.getDate().durationFrom(triggerDate)) * .withMaxCheck(1e10); * </pre></code> * diff --git a/src/main/java/org/orekit/propagation/integration/FieldAdditionalEquations.java b/src/main/java/org/orekit/propagation/integration/FieldAdditionalEquations.java index 327eaec6b1d59818a46c33b31a4d0e13159abb6b..43b10bab1f66782aa0db9cf17b521fe6c7124451 100644 --- a/src/main/java/org/orekit/propagation/integration/FieldAdditionalEquations.java +++ b/src/main/java/org/orekit/propagation/integration/FieldAdditionalEquations.java @@ -18,8 +18,6 @@ package org.orekit.propagation.integration; import org.hipparchus.RealFieldElement; import org.orekit.propagation.FieldSpacecraftState; -import org.orekit.propagation.SpacecraftState; -import org.orekit.time.AbsoluteDate; import org.orekit.time.FieldAbsoluteDate; /** This interface allows users to add their own differential equations to a numerical propagator. @@ -45,8 +43,8 @@ import org.orekit.time.FieldAbsoluteDate; * the pDot array, which is the time-derivative of the p array. Since the additional parameters * p may also have an influence on the equations of motion themselves that should be accumulated * to the main state derivatives (for example an equation linked to a complex thrust model may - * induce an acceleration and a mass change), the {@link #computeDerivatives(FieldSpacecraftState, RealFieldElement[]) - * computeDerivatives} method can return a double array that will be + * induce an acceleration and a mass change), the {@link #computeDerivatives(FieldSpacecraftState, + * RealFieldElement[]) computeDerivatives} method can return a double array that will be * <em>added</em> to the main state derivatives. This means these equations can be used as an * additional force model if needed. If the additional parameters have no influence at all on * the main spacecraft state, a null reference may be returned. @@ -73,7 +71,7 @@ public interface FieldAdditionalEquations<T extends RealFieldElement<T>> { * * <p> * This method will be called once at propagation start, - * before any calls to {@link #computeDerivatives(SpacecraftState , AbsoluteDate[])}. + * before any calls to {@link #computeDerivatives(FieldSpacecraftState , RealFieldElement[])}. * </p> * * <p> diff --git a/src/main/java/org/orekit/propagation/numerical/FieldNumericalPropagator.java b/src/main/java/org/orekit/propagation/numerical/FieldNumericalPropagator.java index e489b0f8b64d38df715d7f381fa5b2c747d8cf5c..9552f089280663e1d199cfda98d8bdce5ce1e80b 100644 --- a/src/main/java/org/orekit/propagation/numerical/FieldNumericalPropagator.java +++ b/src/main/java/org/orekit/propagation/numerical/FieldNumericalPropagator.java @@ -119,9 +119,9 @@ import org.orekit.utils.TimeStampedFieldPVCoordinates; * final T maxStep = zero.add(500); * final T initStep = zero.add(60); * final double[][] tolerance = FieldNumericalPropagator.tolerances(dP, orbit, OrbitType.EQUINOCTIAL); - * AdaptiveStepsizeFieldIntegrator<T> integrator = new DormandPrince853FieldIntegrator<>(field, minStep, maxStep, tolerance[0], tolerance[1]); + * AdaptiveStepsizeFieldIntegrator<T> integrator = new DormandPrince853FieldIntegrator<>(field, minStep, maxStep, tolerance[0], tolerance[1]); * integrator.setInitialStepSize(initStep); - * propagator = new FieldNumericalPropagator<>(field, integrator); + * propagator = new FieldNumericalPropagator<>(field, integrator); * </pre> * <p>By default, at the end of the propagation, the propagator resets the initial state to the final state, * thus allowing a new propagation to be started from there without recomputing the part already performed. diff --git a/src/main/java/org/orekit/time/AbsoluteDate.java b/src/main/java/org/orekit/time/AbsoluteDate.java index c458b6ea557c9fba1f0bc4ca5f6e99e6cf79bd23..5806a8b48468d4ab1a347c8ae71cbf9bfaa93d8e 100644 --- a/src/main/java/org/orekit/time/AbsoluteDate.java +++ b/src/main/java/org/orekit/time/AbsoluteDate.java @@ -702,7 +702,7 @@ public class AbsoluteDate /** Build an instance corresponding to a Julian Epoch (JE). * <p>According to Lieske paper: <a - * href="http://articles.adsabs.harvard.edu/cgi-bin/nph-iarticle_query?1979A%26A....73..282L&defaultprint=YES&filetype=.pdf."> + * href="http://articles.adsabs.harvard.edu/cgi-bin/nph-iarticle_query?1979A%26A....73..282L&defaultprint=YES&filetype=.pdf."> * Precession Matrix Based on IAU (1976) System of Astronomical Constants</a>, Astronomy and Astrophysics, * vol. 73, no. 3, Mar. 1979, p. 282-284, Julian Epoch is related to Julian Ephemeris Date as:</p> * <pre> @@ -723,7 +723,7 @@ public class AbsoluteDate /** Build an instance corresponding to a Besselian Epoch (BE). * <p>According to Lieske paper: <a - * href="http://articles.adsabs.harvard.edu/cgi-bin/nph-iarticle_query?1979A%26A....73..282L&defaultprint=YES&filetype=.pdf."> + * href="http://articles.adsabs.harvard.edu/cgi-bin/nph-iarticle_query?1979A%26A....73..282L&defaultprint=YES&filetype=.pdf."> * Precession Matrix Based on IAU (1976) System of Astronomical Constants</a>, Astronomy and Astrophysics, * vol. 73, no. 3, Mar. 1979, p. 282-284, Besselian Epoch is related to Julian Ephemeris Date as:</p> * <pre> diff --git a/src/main/java/org/orekit/time/FieldAbsoluteDate.java b/src/main/java/org/orekit/time/FieldAbsoluteDate.java index 8dbf3b7b6dd6bd8a707b5aca06810eaba8c73567..25bcaedfad183550f29abf13450d88044a1f9705 100644 --- a/src/main/java/org/orekit/time/FieldAbsoluteDate.java +++ b/src/main/java/org/orekit/time/FieldAbsoluteDate.java @@ -45,7 +45,7 @@ import org.orekit.utils.Constants; * in UTC and write it in another file in TAI. This can be done as follows:</p> * <pre> * DateTimeComponents utcComponents = readNextDate(); - * FieldAbsoluteDate<T> date = new FieldAbsoluteDate<>(utcComponents, TimeScalesFactory.getUTC()); + * FieldAbsoluteDate<T> date = new FieldAbsoluteDate<>(utcComponents, TimeScalesFactory.getUTC()); * writeNextDate(date.getComponents(TimeScalesFactory.getTAI())); * </pre> * @@ -669,7 +669,7 @@ public class FieldAbsoluteDate<T extends RealFieldElement<T>> /** Build an instance corresponding to a Julian Epoch (JE). * <p>According to Lieske paper: <a - * href="http://articles.adsabs.harvard.edu/cgi-bin/nph-iarticle_query?1979A%26A....73..282L&defaultprint=YES&filetype=.pdf."> + * href="http://articles.adsabs.harvard.edu/cgi-bin/nph-iarticle_query?1979A%26A....73..282L&defaultprint=YES&filetype=.pdf."> * Precession Matrix Based on IAU (1976) System of Astronomical Constants</a>, Astronomy and Astrophysics, * vol. 73, no. 3, Mar. 1979, p. 282-284, Julian Epoch is related to Julian Ephemeris Date as:</p> * <pre> @@ -691,7 +691,7 @@ public class FieldAbsoluteDate<T extends RealFieldElement<T>> /** Build an instance corresponding to a Besselian Epoch (BE). * <p>According to Lieske paper: <a - * href="http://articles.adsabs.harvard.edu/cgi-bin/nph-iarticle_query?1979A%26A....73..282L&defaultprint=YES&filetype=.pdf."> + * href="http://articles.adsabs.harvard.edu/cgi-bin/nph-iarticle_query?1979A%26A....73..282L&defaultprint=YES&filetype=.pdf."> * Precession Matrix Based on IAU (1976) System of Astronomical Constants</a>, Astronomy and Astrophysics, * vol. 73, no. 3, Mar. 1979, p. 282-284, Besselian Epoch is related to Julian Ephemeris Date as:</p> * <pre> @@ -814,7 +814,7 @@ public class FieldAbsoluteDate<T extends RealFieldElement<T>> /** Get a time-shifted date. * <p> - * Calling this method is equivalent to call <code>new FieldAbsoluteDate<>(this, dt)</code>. + * Calling this method is equivalent to call {@code new FieldAbsoluteDate<>(this, dt)}. * </p> * @param dt time shift in seconds * @return a new date, shifted with respect to instance (which is immutable) diff --git a/src/main/java/org/orekit/time/FieldTimeStamped.java b/src/main/java/org/orekit/time/FieldTimeStamped.java index 3982d0e9ff5a3a6ddc79b2d72a8883a1aa58656b..3f312bc2c54805ec184d4c1216763601b998c3bb 100644 --- a/src/main/java/org/orekit/time/FieldTimeStamped.java +++ b/src/main/java/org/orekit/time/FieldTimeStamped.java @@ -25,8 +25,8 @@ import org.hipparchus.RealFieldElement; * underlying comparator. An example using for {@link org.orekit.orbits.Orbit * Orbit} instances is given here:</p> * <pre> - * SortedSet<Orbit> sortedOrbits = - * new TreeSet<Orbit>(new ChronologicalComparator()); + * SortedSet<Orbit> sortedOrbits = + * new TreeSet<Orbit>(new ChronologicalComparator()); * sortedOrbits.add(orbit1); * sortedOrbits.add(orbit2); * ...