Commit b9e35b0e authored by Luc Maisonobe's avatar Luc Maisonobe

Fixed javadoc errors.

parent e887fd76
......@@ -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 &copy; ${project.inceptionYear}-{currentYear} <a href="http://www.c-s.fr">CS Syst&egrave;mes d&apos;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>
......
......@@ -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,
......
......@@ -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
......
......@@ -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
......
......@@ -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();
......
......@@ -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,
......
......@@ -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
*/
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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>
......
......@@ -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 &le; ANGLE_1 &lt; 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 &le; ANGLE_2 &lt; 360.0.<p>
* Units shall be degrees.<p>
* See meta-data keyword ANGLE_TYPE for the definition of the angles.
*/
......
......@@ -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 &amp; 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 &amp; 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 &amp; 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 &amp; 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 &amp; 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
......
......@@ -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 &amp; 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 &amp; 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 &amp; 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 &amp; Lya 81-day ave. centered index
*/
double getY10B(AbsoluteDate date);
......
......@@ -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 &amp; al (Naval Research Laboratory), 2001: FORTRAN routine
* @author Dominik Brodowski, 2004: C routine
* @author Pascal Parraud, 2016: Java translation
* @since 8.1
......
......@@ -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>
......
......@@ -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> -&gt zenith hydrostatic delay
* <li>double[1] = D<sub>wz</sub> -&gt 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> -&gt zenith hydrostatic delay
* <li>T[1] = D<sub>wz</sub> -&gt 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.
......
......@@ -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> -&gt zenith hydrostatic delay
* <li>double[1] = D<sub>tz</sub> -&gt 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> -&gt zenith hydrostatic delay
* <li>double[1] = D<sub>tz</sub> -&gt 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
......
......@@ -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
......
......@@ -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) -&gt hydrostatic mapping function
* <li>double[1] = m<sub>w</sub>(e) -&gt 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) -&gt hydrostatic mapping function
* <li>T[1] = m<sub>w</sub>(e) -&gt 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.
......
......@@ -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% -&gt; 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) -&gt total mapping function
* <li>double[1] = m(e) -&gt 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% -&gt; 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) {
......
......@@ -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> -&gt zenith hydrostatic delay
* <li>double[1] = D<sub>wz</sub> -&gt 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> -&gt zenith hydrostatic delay
* <li>double[1] = D<sub>wz</sub> -&gt 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) -&gt hydrostatic mapping function
* <li>double[1] = m<sub>w</sub>(e) -&gt 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) -&gt hydrostatic mapping function
* <li>double[1] = m<sub>w</sub>(e) -&gt 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.
......
......@@ -142,8 +142,8 @@ public class ViennaModelCoefficientsLoader implements DataLoader {
/** Returns the zenith delay array.
* <ul>
* <li>double[0] = D<sub>hz</sub> -&gt zenith hydrostatic delay
* <li>double[1] = D<sub>wz</sub> -&gt 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
*/
......
......@@ -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,
......
......@@ -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++++]&gt;
* |
* propagator 2 : ----[++++current step++++]--------->
* propagator 2 : ----[++++current step++++]---------&gt;
* | |
* ... | |
* propagator n : ---------[++++current step++++]---->
* propagator n : ---------[++++current step++++]----&gt;
* | |
* V V
* global handler : -------------[global step]--------->
* global handler : -------------[global step]---------&gt;
* </pre>
* <p>
* The previous sketch shows that propagator 1 has already computed states
......
......@@ -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 &lt; 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
......
......@@ -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) -&gt; s.getDate().durationFrom(triggerDate))
* .withMaxCheck(1e10);
* </pre></code>
*
......
......@@ -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>
......
......@@ -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&lt;T&gt; integrator = new DormandPrince853FieldIntegrator&lt;&gt;(field, minStep, maxStep, tolerance[0], tolerance[1]);
* integrator.setInitialStepSize(initStep);
* propagator = new FieldNumericalPropagator<>(field, integrator);
* propagator = new FieldNumericalPropagator&lt;&gt;(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.
......
......@@ -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&amp;defaultprint=YES&amp;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&amp;defaultprint=YES&amp;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>
......
......@@ -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&lt;T&gt; date = new FieldAbsoluteDate&lt;&gt;(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&amp;defaultprint=YES&amp;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&amp;defaultprint=YES&amp;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&lt;&gt;(this, dt)}.
* </p>
* @param dt time shift in seconds
* @return a new date, shifted with respect to instance (which is immutable)
......
......@@ -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&lt;Orbit> sortedOrbits =
* new TreeSet&lt;Orbit>(new ChronologicalComparator());
* SortedSet&lt;Orbit&gt; sortedOrbits =
* new TreeSet&lt;Orbit&gt;(new ChronologicalComparator());
* sortedOrbits.add(orbit1);
* sortedOrbits.add(orbit2);
* ...
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment