Commit 018bf6fd authored by Bryan Cazabonne's avatar Bryan Cazabonne
Browse files

Fixed JavaDoc warnings.

parent e8171b97
Pipeline #196 passed with stage
in 19 minutes and 19 seconds
......@@ -25,14 +25,14 @@ import org.orekit.gnss.SatelliteSystem;
* combination of measurements.
* </p>
* <pre>
* m<sub>f</sub> = 0.5 * (Φ<sub>f</sub> + R<sub>f</sub>)
* mf = 0.5 * (Φf + Rf)
* </pre>
* With:
* <ul>
* <li>m<sub>f</sub> : GRAPHIC measurement.</li>
* <li>Φ<sub>f</sub> : Phase measurement.</li>
* <li>R<sub>f</sub> : Code measurement.</li>
* <li>f : Frequency.</li>
* <li>mf : GRAPHIC measurement.</li>
* <li>Φf : Phase measurement.</li>
* <li>Rf : Code measurement.</li>
* <li>f : Frequency.</li>
* </ul>
* @author Bryan Cazabonne
* @since 10.1
......
......@@ -35,18 +35,18 @@ import org.orekit.gnss.SatelliteSystem;
* narrow-lane combination of code measurements.
* </p>
* <pre>
* m<sub>MW</sub> = Φ<sub>WL</sub> - R<sub>NL</sub>
* m<sub>MW</sub> = λ<sub>WL</sub> * N<sub>WL</sub> + b + ε
* mMW = ΦWL- RNL
* mMW = λWL * NWL+ b + ε
* </pre>
* With:
* <ul>
* <li>m<sub>MW</sub> : Melbourne-Wübbena measurement.</li>
* <li>Φ<sub>WL</sub> : Wide-Lane phase measurement.</li>
* <li>R<sub>NL</sub> : Narrow-Lane code measurement.</li>
* <li>λ<sub>WL</sub> : Wide-Lane wavelength.</li>
* <li>N<sub>WL</sub> : Wide-Lane ambiguity (N<sub>f1</sub> - N<sub>f2</sub>).</li>
* <li>b : Satellite and receiver instrumental delays.</li>
* <li>ε : Measurement noise.</li>
* <li>mMW : Melbourne-Wübbena measurement.</li>
* <li>ΦWL : Wide-Lane phase measurement.</li>
* <li>RNL : Narrow-Lane code measurement.</li>
* <li>λWL : Wide-Lane wavelength.</li>
* <li>NWL : Wide-Lane ambiguity (Nf1 - Nf2).</li>
* <li>b : Satellite and receiver instrumental delays.</li>
* <li>ε : Measurement noise.</li>
* </ul>
* <p>
* {@link NarrowLaneCombination Narrow-Lane} and {@link WideLaneCombination Wide-Lane}
......
......@@ -25,14 +25,14 @@ import org.orekit.gnss.SatelliteSystem;
* measurements that can be used for cycle-slip detection.
* </p>
* <pre>
* m<sub>f</sub> = Φ<sub>f</sub> - R<sub>f</sub>
* mf = Φf - Rf
* </pre>
* With:
* <ul>
* <li>m<sub>f</sub> : Phase minus Code measurement.</li>
* <li>Φ<sub>f</sub> : Phase measurement.</li>
* <li>R<sub>f</sub> : Code measurement.</li>
* <li>f : Frequency.</li>
* <li>mf : Phase minus Code measurement.</li>
* <li>Φf : Phase measurement.</li>
* <li>Rf : Code measurement.</li>
* <li>f : Frequency.</li>
* </ul>
* @author Bryan Cazabonne
* @since 10.1
......
......@@ -507,13 +507,13 @@ public class FieldSpacecraftState <T extends RealFieldElement<T>>
* </p>
* <table border="1" cellpadding="5">
* <caption>Extrapolation Error</caption>
* <tr bgcolor="#ccccff"><th>interpolation time (s)</th>
* <tr style="background-color: #ccccff;"><th>interpolation time (s)</th>
* <th>position error without derivatives (m)</th><th>position error with derivatives (m)</th></tr>
* <tr><td bgcolor="#eeeeff"> 60</td><td> 18</td><td> 1.1</td></tr>
* <tr><td bgcolor="#eeeeff">120</td><td> 72</td><td> 9.1</td></tr>
* <tr><td bgcolor="#eeeeff">300</td><td> 447</td><td> 140</td></tr>
* <tr><td bgcolor="#eeeeff">600</td><td>1601</td><td>1067</td></tr>
* <tr><td bgcolor="#eeeeff">900</td><td>3141</td><td>3307</td></tr>
* <tr><td style="background-color: #eeeeff;"> 60</td><td> 18</td><td> 1.1</td></tr>
* <tr><td style="background-color: #eeeeff;">120</td><td> 72</td><td> 9.1</td></tr>
* <tr><td style="background-color: #eeeeff;">300</td><td> 447</td><td> 140</td></tr>
* <tr><td style="background-color: #eeeeff;">600</td><td>1601</td><td>1067</td></tr>
* <tr><td style="background-color: #eeeeff;">900</td><td>3141</td><td>3307</td></tr>
* </table>
* @param dt time shift in seconds
* @return a new state, shifted with respect to the instance (which is immutable)
......@@ -548,13 +548,13 @@ public class FieldSpacecraftState <T extends RealFieldElement<T>>
* </p>
* <table border="1" cellpadding="5">
* <caption>Extrapolation Error</caption>
* <tr bgcolor="#ccccff"><th>interpolation time (s)</th>
* <tr style="background-color: #ccccff;"><th>interpolation time (s)</th>
* <th>position error without derivatives (m)</th><th>position error with derivatives (m)</th></tr>
* <tr><td bgcolor="#eeeeff"> 60</td><td> 18</td><td> 1.1</td></tr>
* <tr><td bgcolor="#eeeeff">120</td><td> 72</td><td> 9.1</td></tr>
* <tr><td bgcolor="#eeeeff">300</td><td> 447</td><td> 140</td></tr>
* <tr><td bgcolor="#eeeeff">600</td><td>1601</td><td>1067</td></tr>
* <tr><td bgcolor="#eeeeff">900</td><td>3141</td><td>3307</td></tr>
* <tr><td style="background-color: #eeeeff;"> 60</td><td> 18</td><td> 1.1</td></tr>
* <tr><td style="background-color: #eeeeff;">120</td><td> 72</td><td> 9.1</td></tr>
* <tr><td style="background-color: #eeeeff;">300</td><td> 447</td><td> 140</td></tr>
* <tr><td style="background-color: #eeeeff;">600</td><td>1601</td><td>1067</td></tr>
* <tr><td style="background-color: #eeeeff;">900</td><td>3141</td><td>3307</td></tr>
* </table>
* @param dt time shift in seconds
* @return a new state, shifted with respect to the instance (which is immutable)
......
......@@ -423,13 +423,13 @@ public class SpacecraftState
* </p>
* <table border="1" cellpadding="5">
* <caption>Extrapolation Error</caption>
* <tr bgcolor="#ccccff"><th>interpolation time (s)</th>
* <tr style="background-color: #ccccff;"><th>interpolation time (s)</th>
* <th>position error without derivatives (m)</th><th>position error with derivatives (m)</th></tr>
* <tr><td bgcolor="#eeeeff"> 60</td><td> 18</td><td> 1.1</td></tr>
* <tr><td bgcolor="#eeeeff">120</td><td> 72</td><td> 9.1</td></tr>
* <tr><td bgcolor="#eeeeff">300</td><td> 447</td><td> 140</td></tr>
* <tr><td bgcolor="#eeeeff">600</td><td>1601</td><td>1067</td></tr>
* <tr><td bgcolor="#eeeeff">900</td><td>3141</td><td>3307</td></tr>
* <tr><td style="background-color: #eeeeff;"> 60</td><td> 18</td><td> 1.1</td></tr>
* <tr><td style="background-color: #eeeeff;">120</td><td> 72</td><td> 9.1</td></tr>
* <tr><td style="background-color: #eeeeff;">300</td><td> 447</td><td> 140</td></tr>
* <tr><td style="background-color: #eeeeff;">600</td><td>1601</td><td>1067</td></tr>
* <tr><td style="background-color: #eeeeff;">900</td><td>3141</td><td>3307</td></tr>
* </table>
* @param dt time shift in seconds
* @return a new state, shifted with respect to the instance (which is immutable)
......
......@@ -84,13 +84,14 @@ public class BeidouPropagator extends AbstractGNSSPropagator {
* </p>
*
* <p>This constructor uses the {@link DataContext#getDefault() default data context}.
* Another data context can be set using
* {@code Builder(final BeidouOrbitalElements gpsOrbElt, final Frames frames)}</p>
*
* @param bdsOrbElt the Beidou orbital elements to be used by the Beidou propagator.
* @see #attitudeProvider(AttitudeProvider provider)
* @see #mass(double mass)
* @see #eci(Frame inertial)
* @see #ecef(Frame bodyFixed)
* @see #BeidouPropagator.Builder(BeidouOrbitalElements bdsOrbElt, Frames frames)
*/
@DefaultDataContext
public Builder(final BeidouOrbitalElements bdsOrbElt) {
......
......@@ -156,13 +156,14 @@ public class GLONASSAnalyticalPropagator extends AbstractAnalyticalPropagator {
* </p>
*
* <p>This constructor uses the {@link DataContext#getDefault() default data context}.
* Another data context can be set using
* {@code Builder(final GLONASSOrbitalElements gpsOrbElt, final DataContext dataContext)}</p>
*
* @param glonassOrbElt the GLONASS orbital elements to be used by the GLONASS propagator.
* @see #attitudeProvider(AttitudeProvider provider)
* @see #mass(double mass)
* @see #eci(Frame inertial)
* @see #ecef(Frame bodyFixed)
* @see #GLONASSAnalyticalPropagator.Builder(GLONASSOrbitalElements glonassOrbElt, DataContext dataContext)
*/
@DefaultDataContext
public Builder(final GLONASSOrbitalElements glonassOrbElt) {
......
......@@ -82,13 +82,14 @@ public class GPSPropagator extends AbstractGNSSPropagator {
* </p>
*
* <p>This constructor uses the {@link DataContext#getDefault() default data context}.
* Another data context can be set using
* {@code Builder(final GPSOrbitalElements gpsOrbElt, final Frames frames)}</p>
*
* @param gpsOrbElt the GPS orbital elements to be used by the GPSpropagator.
* @see #attitudeProvider(AttitudeProvider provider)
* @see #mass(double mass)
* @see #eci(Frame inertial)
* @see #ecef(Frame bodyFixed)
* @see #GPSPropagator.Builder(GPSOrbitalElements gpsOrbElt, Frames frames)
*/
@DefaultDataContext
public Builder(final GPSOrbitalElements gpsOrbElt) {
......
......@@ -83,13 +83,14 @@ public class GalileoPropagator extends AbstractGNSSPropagator {
* </p>
*
* <p>This constructor uses the {@link DataContext#getDefault() default data context}.
* Another data context can be set using
* {@code Builder(final GalileoOrbitalElements gpsOrbElt, final Frames frames)}</p>
*
* @param galileoOrbElt the Galileo orbital elements to be used by the Galileo propagator.
* @see #attitudeProvider(AttitudeProvider provider)
* @see #mass(double mass)
* @see #eci(Frame inertial)
* @see #ecef(Frame bodyFixed)
* @see #GalileoPropagator.Builder(GalileoOrbitalElements galileoOrbElt, Frames frames)
*/
@DefaultDataContext
public Builder(final GalileoOrbitalElements galileoOrbElt) {
......
......@@ -85,13 +85,14 @@ public class QZSSPropagator extends AbstractGNSSPropagator {
* </p>
*
* <p>This constructor uses the {@link DataContext#getDefault() default data context}.
* Another data context can be set using
* {@code Builder(final QZSSOrbitalElements gpsOrbElt, final Frames frames)}</p>
*
* @param qzssOrbElt the QZSS orbital elements to be used by the QZSSpropagator.
* @see #attitudeProvider(AttitudeProvider provider)
* @see #mass(double mass)
* @see #eci(Frame inertial)
* @see #ecef(Frame bodyFixed)
* @see #QZSSPropagator.Builder(QZSSOrbitalElements qzssOrbElt, Frames frames)
*/
@DefaultDataContext
public Builder(final QZSSOrbitalElements qzssOrbElt) {
......
......@@ -33,7 +33,7 @@ public abstract class AbstractDetector<T extends AbstractDetector<T>> implements
/** Default convergence threshold (s). */
public static final double DEFAULT_THRESHOLD = 1.e-6;
/** Default cmaximum number of iterations in the event time search. */
/** Default maximum number of iterations in the event time search. */
public static final int DEFAULT_MAX_ITER = 100;
/** Max check interval. */
......
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