Commit be8112bf authored by Bryan Cazabonne's avatar Bryan Cazabonne
Browse files

Fixed JavaDoc due to incompatibilities with HTML5.

parent bcc63808
......@@ -82,22 +82,22 @@ 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;" summary="">
* <table border="1" style="background-color:#f5f5dc;">
* <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>
* <tr><td style="background-color:#c9d5c9; padding:5px">GRS 80</td>
* <td>{@link org.orekit.utils.Constants#GRS80_EARTH_EQUATORIAL_RADIUS Constants.GRS80_EARTH_EQUATORIAL_RADIUS}</td>
* <td>{@link org.orekit.utils.Constants#GRS80_EARTH_FLATTENING Constants.GRS80_EARTH_FLATTENING}</td></tr>
* <tr><td style="background-color:#c9d5c9;">WGS84</td>
* <tr><td style="background-color:#c9d5c9; padding:5px">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>
* <tr><td style="background-color:#c9d5c9;">IERS96</td>
* <tr><td style="background-color:#c9d5c9; padding:5px">IERS96</td>
* <td>{@link org.orekit.utils.Constants#IERS96_EARTH_EQUATORIAL_RADIUS Constants.IERS96_EARTH_EQUATORIAL_RADIUS}</td>
* <td>{@link org.orekit.utils.Constants#IERS96_EARTH_FLATTENING Constants.IERS96_EARTH_FLATTENING}</td></tr>
* <tr><td style="background-color:#c9d5c9;">IERS2003</td>
* <tr><td style="background-color:#c9d5c9; padding:5px">IERS2003</td>
* <td>{@link org.orekit.utils.Constants#IERS2003_EARTH_EQUATORIAL_RADIUS Constants.IERS2003_EARTH_EQUATORIAL_RADIUS}</td>
* <td>{@link org.orekit.utils.Constants#IERS2003_EARTH_FLATTENING Constants.IERS2003_EARTH_FLATTENING}</td></tr>
* <tr><td style="background-color:#c9d5c9;">IERS2010</td>
* <tr><td style="background-color:#c9d5c9; padding:5px">IERS2010</td>
* <td>{@link org.orekit.utils.Constants#IERS2010_EARTH_EQUATORIAL_RADIUS Constants.IERS2010_EARTH_EQUATORIAL_RADIUS}</td>
* <td>{@link org.orekit.utils.Constants#IERS2010_EARTH_FLATTENING Constants.IERS2010_EARTH_FLATTENING}</td></tr>
* </table>
......
......@@ -44,7 +44,7 @@ import org.orekit.utils.TimeStampedAngularCoordinates;
*
* <p> Each instance corresponds to a single AEM file.
*
* <h3> Metadata </h3>
* <h2> Metadata </h2>
*
* <p> The AEM metadata used by this writer is described in the following table. Many
* metadata items are optional or have default values so they do not need to be specified.
......@@ -56,7 +56,8 @@ import org.orekit.utils.TimeStampedAngularCoordinates;
* <p> The AEM metadata for the whole AEM file is set in the {@link
* #StreamingAemWriter(Appendable, TimeScale, Map) constructor}.
*
* <table summary="AEM metada">
* <table>
* <caption>AEM metadata</caption>
* <thead>
* <tr>
* <th>Keyword
......
......@@ -56,7 +56,7 @@ import org.orekit.utils.TimeStampedPVCoordinates;
* <p> Each instance corresponds to a single OEM file. A new OEM ephemeris segment is
* started by calling {@link #newSegment(Frame, Map)}.
*
* <h3> Metadata </h3>
* <h2> Metadata </h2>
*
* <p> The OEM metadata used by this writer is described in the following table. Many
* metadata items are optional or have default values so they do not need to be specified.
......@@ -70,7 +70,8 @@ import org.orekit.utils.TimeStampedPVCoordinates;
* be overridden for a particular segment using the {@code metadata} argument to {@link
* #newSegment(Frame, Map)}.
*
* <table summary="OEM metada">
* <table>
* <caption>OEM metadata</caption>
* <thead>
* <tr>
* <th>Keyword
......@@ -170,7 +171,7 @@ import org.orekit.utils.TimeStampedPVCoordinates;
* <tr>
* <td>{@link Keyword#INTERPOLATION}
* <td>Segment
* <td>No
* <td>Noupday
* <td>
* <td>Table 5-3
* <tr>
......@@ -193,7 +194,7 @@ import org.orekit.utils.TimeStampedPVCoordinates;
* are EME2000, GCRF, GRC, ICRF, ITRF2000, ITRF-93, ITRF-97, MCI, TDR, TEME, and TOD.
* Additionally ITRF followed by a four digit year may be used.
*
* <h3> Examples </h3>
* <h2> Examples </h2>
*
* <p> This class can be used as a step handler for a {@link Propagator}, or on its own.
* Either way the object name and ID must be specified. The following example shows its
......
......@@ -117,7 +117,7 @@ public class CPFFile implements EphemerisFile {
/**
* Set the interpolation sample.
* @param interpolationSample
* @param interpolationSample interpolation sample
*/
public void setInterpolationSample(final int interpolationSample) {
this.interpolationSample = interpolationSample;
......
......@@ -360,7 +360,7 @@ public class CRDFile {
/** Elevation [rad]. */
private final double elevation;
/** Direction flag (0 = transmit & receive ; 1 = transmit ; 2 = receive). */
/** Direction flag (0 = transmit &#38; receive ; 1 = transmit ; 2 = receive). */
private final int directionFlag;
/** Angle origin indicator.
......@@ -423,7 +423,7 @@ public class CRDFile {
}
/**
* Get the direction flag (0 = transmit & receive ; 1 = transmit ; 2 = receive).
* Get the direction flag (0 = transmit &#38; receive ; 1 = transmit ; 2 = receive).
* @return the direction flag
*/
public int getDirectionFlag() {
......
......@@ -57,9 +57,9 @@ import org.orekit.utils.TimeStampedPVCoordinates;
*
* <p>Instances of this class are guaranteed to be immutable.</p>
*
* <h1> Examples </h1>
* <h2> Examples </h2>
*
* <h2> Example of translation from R<sub>A</sub> to R<sub>B</sub> </h2>
* <h3> Example of translation from R<sub>A</sub> to R<sub>B</sub> </h3>
*
* <p> We want to transform the {@link FieldPVCoordinates} PV<sub>A</sub> to
* PV<sub>B</sub> with :
......@@ -78,7 +78,7 @@ import org.orekit.utils.TimeStampedPVCoordinates;
* PVB = R1toR2.transformPVCoordinate(PVA);
* </pre>
*
* <h2> Example of rotation from R<sub>A</sub> to R<sub>B</sub> </h2>
* <h3> Example of rotation from R<sub>A</sub> to R<sub>B</sub> </h3>
* <p> We want to transform the {@link FieldPVCoordinates} PV<sub>A</sub> to
* PV<sub>B</sub> with
*
......
......@@ -27,7 +27,7 @@ import org.orekit.time.FieldAbsoluteDate;
/** Tridimensional references frames class.
*
* <h1> Frame Presentation </h1>
* <h2> Frame Presentation </h2>
* <p>This class is the base class for all frames in OREKIT. The frames are
* linked together in a tree with some specific frame chosen as the root of the tree.
* Each frame is defined by {@link Transform transforms} combining any number
......
......@@ -26,7 +26,7 @@ import org.orekit.utils.IERSConventions;
/** Factory for predefined reference frames.
*
* <h1> FramesFactory Presentation </h1>
* <h2> FramesFactory Presentation </h2>
* <p>
* Several predefined reference {@link Frame frames} are implemented in OREKIT.
* They are linked together in a tree with the <i>Geocentric
......
......@@ -58,9 +58,9 @@ import org.orekit.utils.TimeStampedPVCoordinates;
*
* <p>Instances of this class are guaranteed to be immutable.</p>
*
* <h1> Examples </h1>
* <h2> Examples </h2>
*
* <h2> Example of translation from R<sub>A</sub> to R<sub>B</sub> </h2>
* <h3> Example of translation from R<sub>A</sub> to R<sub>B</sub> </h3>
*
* <p> We want to transform the {@link PVCoordinates} PV<sub>A</sub> to
* PV<sub>B</sub> with :
......@@ -79,7 +79,7 @@ import org.orekit.utils.TimeStampedPVCoordinates;
* PVB = R1toR2.transformPVCoordinates(PVA);
* </code></pre>
*
* <h2> Example of rotation from R<sub>A</sub> to R<sub>B</sub> </h2>
* <h3> Example of rotation from R<sub>A</sub> to R<sub>B</sub> </h3>
* <p> We want to transform the {@link PVCoordinates} PV<sub>A</sub> to
* PV<sub>B</sub> with
*
......
......@@ -28,7 +28,7 @@
* org.orekit.orbits.CartesianOrbit Cartesian} representations are supported.
* </p>
*
* <h3>Design History</h3>
* <h2>Design History</h2>
* <p>
* Early designs for the orbit package were much more complex than the current design.
* Looking back at these designs, they tried to do far too much in a single class and
......@@ -58,7 +58,7 @@
* easy to maintain and reusable.
* </p>
*
* <h3>Current state versus evolving state</h3>
* <h2>Current state versus evolving state</h2>
* <p>
* From the early design, the various orbit classes retained only the kinematical
* notions at a single time. They basically represent the current state, and
......@@ -93,7 +93,7 @@
* conversions to other frames without having to externally preserve a mapping
* between orbits and their frame: it is already done. As an example, getting
* the position and velocity of a satellite given by a circular orbit in a ground
* station frame is simply a matter of calling <tt>orbit.getPVCoordinates(stationFrame)</tt>,
* station frame is simply a matter of calling <code>orbit.getPVCoordinates(stationFrame)</code>,
* regardless of the frame in which the orbit is defined (GCRF, EME2000, ...).
* </p>
*
......@@ -114,7 +114,7 @@
* interface.
* </p>
*
* <h3>Representations Conversions</h3>
* <h2>Representations Conversions</h2>
* <p>
* All representations can be converted into all other ones. No error is triggered
* if some conversion is ambiguous (like converting a perfectly circular orbit from
......
<html>
OREKIT
<body>
<h2>1. Purpose</h2>
<h1>1. Purpose</h1>
<p>
OREKIT library is a low-level library for space mechanics projects. It is
implemented in the JAVA language.
......@@ -25,7 +25,7 @@ implemented in the JAVA language.
filesystem layout ...)</li>
</ul>
<h2>2. Features</h2>
<h1>2. Features</h1>
<p>
Orekit can be used for many purposes, from simple geometrical or orbital tools
up to complex orbits propagators with several perturbing forces, maneuvers and
......@@ -303,7 +303,7 @@ discrete events. Here is a short list of the features offered by the library:</p
</li>
</ul>
<h2>3. Dependency</h2>
<h1>3. Dependency</h1>
<p>
OREKIT has only one dependency: the <a href="https://hipparchus.org/">Hipparchus</a>
open-source library. This library provides mathematical tools for many purposes: geometry,
......
......@@ -505,15 +505,15 @@ public class FieldSpacecraftState <T extends RealFieldElement<T>>
* Sun and Moon third bodies attractions, drag and solar radiation pressure.
* Beware that these results will be different for other orbits.
* </p>
* <table border="1" cellpadding="5">
* <table border="1">
* <caption>Extrapolation Error</caption>
* <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 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>
* <tr><td style="background-color: #eeeeff; padding:5px"> 60</td><td> 18</td><td> 1.1</td></tr>
* <tr><td style="background-color: #eeeeff; padding:5px">120</td><td> 72</td><td> 9.1</td></tr>
* <tr><td style="background-color: #eeeeff; padding:5px">300</td><td> 447</td><td> 140</td></tr>
* <tr><td style="background-color: #eeeeff; padding:5px">600</td><td>1601</td><td>1067</td></tr>
* <tr><td style="background-color: #eeeeff; padding:5px">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)
......@@ -546,15 +546,15 @@ public class FieldSpacecraftState <T extends RealFieldElement<T>>
* Sun and Moon third bodies attractions, drag and solar radiation pressure.
* Beware that these results will be different for other orbits.
* </p>
* <table border="1" cellpadding="5">
* <table border="1">
* <caption>Extrapolation Error</caption>
* <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 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>
* <tr><td style="background-color: #eeeeff; padding:5px"> 60</td><td> 18</td><td> 1.1</td></tr>
* <tr><td style="background-color: #eeeeff; padding:5px">120</td><td> 72</td><td> 9.1</td></tr>
* <tr><td style="background-color: #eeeeff; padding:5px">300</td><td> 447</td><td> 140</td></tr>
* <tr><td style="background-color: #eeeeff; padding:5px">600</td><td>1601</td><td>1067</td></tr>
* <tr><td style="background-color: #eeeeff; padding:5px">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)
......
......@@ -421,15 +421,15 @@ public class SpacecraftState
* Sun and Moon third bodies attractions, drag and solar radiation pressure.
* Beware that these results will be different for other orbits.
* </p>
* <table border="1" cellpadding="5">
* <table border="1">
* <caption>Extrapolation Error</caption>
* <tr style="background-color: #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 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>
* <tr><td style="background-color: #eeeeff; padding:5px"> 60</td><td> 18</td><td> 1.1</td></tr>
* <tr><td style="background-color: #eeeeff; padding:5px">120</td><td> 72</td><td> 9.1</td></tr>
* <tr><td style="background-color: #eeeeff; padding:5px">300</td><td> 447</td><td> 140</td></tr>
* <tr><td style="background-color: #eeeeff; padding:5px">600</td><td>1601</td><td>1067</td></tr>
* <tr><td style="background-color: #eeeeff; padding:5px">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)
......
......@@ -34,7 +34,7 @@ import org.orekit.time.AbsoluteDate;
* the same event can lead to non-deterministic behaviour.
* This handler manages several handlers. The action returned is based on a priority rule
* (see {@link #eventOccurred}) :
* {@link Action#STOP stop} > {@link Action#RESET_STATE resetState} > {@link Action#RESET_DERIVATIVES resetDerivatives} > {@link Action#RESET_EVENTS resetRevents} > {@link Action#CONTINUE continue}
* {@link Action#STOP stop} &#62; {@link Action#RESET_STATE resetState} &#62; {@link Action#RESET_DERIVATIVES resetDerivatives} &#62; {@link Action#RESET_EVENTS resetRevents} &#62; {@link Action#CONTINUE continue}
*
* @author Lara Hué
*
......
......@@ -15,7 +15,7 @@
* limitations under the License.
*/
/**
* <h1> Propagation </h1>
* <h2> Propagation </h2>
*
* This package provides tools to propagate orbital states with different methods.
*
......@@ -33,7 +33,7 @@
* the state.
* </p>
*
* <h2> Keplerian propagation </h2>
* <h3> Keplerian propagation </h3>
*
* <p> The {@link org.orekit.propagation.analytical.KeplerianPropagator}
* implements the {@link org.orekit.propagation.Propagator}
......@@ -43,7 +43,7 @@
* {@link org.orekit.orbits.EquinoctialOrbit}
* representation: only the mean anomaly value changes.
*
* <h2> Eckstein-Hechler propagation </h2>
* <h3> Eckstein-Hechler propagation </h3>
*
* <p> This analytical model is suited for near circular orbits and inclination
* neither equatorial nor critical. It considers J2 to J6 potential
......@@ -51,7 +51,7 @@
* position. As the Keplerian propagator, it implements the
* {@link org.orekit.propagation.Propagator} interface.
*
* <h2> Numerical propagation </h2>
* <h3> Numerical propagation </h3>
*
* <p> It is the most important part of the OREKIT project. Based on Hipparchus
* integrators, the {@link org.orekit.propagation.numerical.NumericalPropagator}
......
......@@ -53,7 +53,7 @@ public class AGILeapSecondFilesLoader extends AbstractSelfFeedingLoader
* DataContext#getDefault() default data context}.
*
* @param supportedNames regular expression for supported files names
* @see #TAIUTCDatFilesLoader(String, DataProvidersManager)
* @see #AGILeapSecondFilesLoader(String, DataProvidersManager)
*/
@DefaultDataContext
public AGILeapSecondFilesLoader(final String supportedNames) {
......
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