Skip to content
GitLab
Menu
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Bryan Cazabonne
Orekit
Commits
725b8d85
Commit
725b8d85
authored
Sep 07, 2021
by
Bryan Cazabonne
Browse files
Fixed JavaDoc warnings.
parent
32b63262
Changes
21
Hide whitespace changes
Inline
Side-by-side
src/main/java/org/orekit/attitudes/TabulatedProvider.java
View file @
725b8d85
...
...
@@ -58,7 +58,7 @@ public class TabulatedProvider implements BoundedAttitudeProvider {
/** Creates new instance.
* <p>
* This constructor uses the first and last point samples as the min and max dates.
* </>
* </
p
>
* @param referenceFrame reference frame for tabulated attitudes
* @param table tabulated attitudes
* @param n number of attitude to use for interpolation
...
...
src/main/java/org/orekit/data/DataSource.java
View file @
725b8d85
...
...
@@ -47,7 +47,6 @@ import java.nio.file.Paths;
* to return the already open stream so a {@code try with resources} clause
* elsewhere works properly for closing the stream</li>
* </ul>
* </p>
* <p>
* Beware that the purpose of this class is only to delay this opening (or not open
* the stream or reader at all), it is <em>not</em> intended to open the stream several
...
...
@@ -56,7 +55,6 @@ import java.nio.file.Paths;
* {@link Opener#openStreamOnce() openStreamOnce} or {@link Opener#openReaderOnce() openReaderOnce}
* methods are called several times or are both called separately. This is particularly
* true in network-based streams.
* </p>
* <p>
* This class is a simple container without any processing methods.
* </p>
...
...
src/main/java/org/orekit/files/ccsds/ndm/ParserBuilder.java
View file @
725b8d85
...
...
@@ -73,7 +73,6 @@ public class ParserBuilder extends AbstractBuilder<ParserBuilder> {
* <li>{@link #getParsedUnitsBehavior() parsed unit behavior} set to {@link ParsedUnitsBehavior#CONVERT_COMPATIBLE}</li>
* <li>{@link #getRangeUnitsConverter() converter for range units} set to {@link IdentityConverter}</li>
* </ul>
* </p>
*/
@DefaultDataContext
public
ParserBuilder
()
{
...
...
@@ -94,7 +93,6 @@ public class ParserBuilder extends AbstractBuilder<ParserBuilder> {
* <li>{@link #getParsedUnitsBehavior() parsed unit behavior} set to {@link ParsedUnitsBehavior#CONVERT_COMPATIBLE}</li>
* <li>{@link #getRangeUnitsConverter() converter for range units} set to {@link IdentityConverter}</li>
* </ul>
* </p>
* @param dataContext data context used to retrieve frames, time scales, etc.
*/
public
ParserBuilder
(
final
DataContext
dataContext
)
{
...
...
src/main/java/org/orekit/files/ccsds/ndm/WriterBuilder.java
View file @
725b8d85
...
...
@@ -53,7 +53,6 @@ public class WriterBuilder extends AbstractBuilder<WriterBuilder> {
* <li>{@link #getMissionReferenceDate() mission reference date} set to {@code null}</li>
* <li>{@link #getRangeUnitsConverter() converter for range units} set to {@link IdentityConverter}</li>
* </ul>
* </p>
*/
@DefaultDataContext
public
WriterBuilder
()
{
...
...
@@ -69,7 +68,6 @@ public class WriterBuilder extends AbstractBuilder<WriterBuilder> {
* <li>{@link #getMissionReferenceDate() mission reference date} set to {@code null}</li>
* <li>{@link #getRangeUnitsConverter() converter for range units} set to {@link IdentityConverter}</li>
* </ul>
* </p>
* @param dataContext data context used to retrieve frames, time scales, etc.
*/
public
WriterBuilder
(
final
DataContext
dataContext
)
{
...
...
src/main/java/org/orekit/files/ccsds/ndm/adm/AttitudeEndoints.java
View file @
725b8d85
...
...
@@ -48,7 +48,6 @@ import org.orekit.utils.TimeStampedFieldAngularCoordinates;
* <li>{@link Attitude Orekit attitude} view: attitude is always from external to
* spacecraft body</li>
* </ul>
* </p>
* @author Luc Maisonobe
* @since 11.0
*/
...
...
src/main/java/org/orekit/files/ccsds/ndm/adm/aem/AemWriter.java
View file @
725b8d85
...
...
@@ -93,7 +93,6 @@ import org.orekit.utils.units.Unit;
* </tr>
* </tbody>
* </table>
* </p>
*
* <p> The AEM metadata for the AEM file is set when calling {@link #writeSegmentContent(Generator, double, AemSegment)},
* the entries are defined in tables 4-3, 4-4 and annex A of the ADM standard.
...
...
@@ -269,7 +268,7 @@ public class AemWriter extends AbstractMessageWriter<Header, AemSegment, Aem> {
* as new segments are written (with at least the segment start and stop will change,
* but some other parts may change too). The {@code template} argument itself is not
* changed.
* </>
* </
p
>
* @param conventions IERS Conventions
* @param dataContext used to retrieve frames, time scales, etc.
* @param missionReferenceDate reference date for Mission Elapsed Time or Mission Relative Time time systems
...
...
src/main/java/org/orekit/files/ccsds/ndm/adm/aem/AttitudeWriter.java
View file @
725b8d85
...
...
@@ -69,7 +69,7 @@ public class AttitudeWriter implements AttitudeEphemerisFileWriter {
* as new segments are written (with at least the segment start and stop will change,
* but some other parts may change too). The {@code template} argument itself is not
* changed.
* </>
* </
p
>
* <p>
* Calling this constructor directly is not recommended. Users should rather use
* {@link org.orekit.files.ccsds.ndm.WriterBuilder#buildAemWriter()}.
...
...
src/main/java/org/orekit/files/ccsds/ndm/odm/ocm/Ocm.java
View file @
725b8d85
...
...
@@ -90,14 +90,12 @@ public class Ocm extends NdmConstituent<Header, Segment<OcmMetadata, OcmData>>
* The metadata entries checked for use as the key are the following ones,
* the first non-null being used. The map from OCM files always contains only
* one object.
* <p>
* <ul>
* <li>{@link org.orekit.files.ccsds.ndm.odm.OdmMetadata#getObjectName() OBJECT_NAME}</li>
* <li>{@link OcmMetadata#getInternationalDesignator() INTERNATIONAL_DESIGNATOR}</li>
* <li>{@link OcmMetadata#getObjectDesignator() OBJECT_DESIGNATOR}</li>
* <li>the default name {@link #UNKNOWN_OBJECT} for unknown objects</li>
* </ul>
* </p>
*/
@Override
public
Map
<
String
,
OcmSatelliteEphemeris
>
getSatellites
()
{
...
...
src/main/java/org/orekit/files/ccsds/ndm/odm/ocm/OrbitCategory.java
View file @
725b8d85
...
...
@@ -22,46 +22,46 @@ package org.orekit.files.ccsds.ndm.odm.ocm;
*/
public
enum
OrbitCategory
{
/** Extended Geostationary Orbit, 37948
< a <
46380 km, e
<
0.25, i
<
25°. */
/** Extended Geostationary Orbit, 37948
< a <
46380 km, e
<
0.25, i
<
25°. */
EGO
(
"Extended Geostationary Orbit"
),
/** Escape Orbit. */
ESO
(
"Escape Orbit"
),
/** GEO-superGEO, Crossing Orbit 31570
< hp <
40002 km, 40002 km
<
ha. */
/** GEO-superGEO, Crossing Orbit 31570
< hp <
40002 km, 40002 km
<
ha. */
GHO
(
"GEO-superGEO, Crossing Orbit"
),
/** Geosynchronous Earth Orbit, with i
>
3°, 35586
< hp <
35986 km, 35586
< ha <
35986 km. */
/** Geosynchronous Earth Orbit, with i
>
3°, 35586
< hp <
35986 km, 35586
< ha <
35986 km. */
GEO
(
"Geosynchronous Earth Orbit"
),
/** GeoStationary Orbit, with 3°
< i <
25°, 35586
< hp <
35986 km, 35586
< ha <
35986 km. */
/** GeoStationary Orbit, with 3°
< i <
25°, 35586
< hp <
35986 km, 35586
< ha <
35986 km. */
GSO
(
"GeoStationary Orbit"
),
/** Geosynchronous Transfer Orbit, i
<
90°, hp
<
2000 km, 31570
< ha <
40002 km. */
/** Geosynchronous Transfer Orbit, i
<
90°, hp
<
2000 km, 31570
< ha <
40002 km. */
GTO
(
"Geosynchronous Transfer Orbit"
),
/** High Altitude Earth Orbit, 40002 km
<
hp, 40002 km
<
ha. */
/** High Altitude Earth Orbit, 40002 km
<
hp, 40002 km
<
ha. */
HAO
(
"High Altitude Earth Orbit"
),
/** Highly Eccentric Earth Orbit, hp
<
31570 km, 40002 km
<
ha. */
/** Highly Eccentric Earth Orbit, hp
<
31570 km, 40002 km
<
ha. */
HEO
(
"Highly Eccentric Earth Orbit"
),
/** Inclined Geosynchronous Orbit, 37948
< a <
46380 km, e
<
0.25, 25°
< i <
180°. */
/** Inclined Geosynchronous Orbit, 37948
< a <
46380 km, e
<
0.25, 25°
< i <
180°. */
IGO
(
"Inclined Geosynchronous Orbit"
),
/** Low Earth Orbit, hp
<
2000 km, ha
<
2000 km. */
/** Low Earth Orbit, hp
<
2000 km, ha
<
2000 km. */
LEO
(
"Low Earth Orbit"
),
/** LEO-MEO Crossing Orbit, hp
<
2000 km, 2000
< ha <
31570 km. */
/** LEO-MEO Crossing Orbit, hp
<
2000 km, 2000
< ha <
31570 km. */
LMO
(
"LEO-MEO Crossing Orbit"
),
/** Medium Earth Orbit, 2000
< hp <
31570 km, 2000
< ha <
31570 km. */
/** Medium Earth Orbit, 2000
< hp <
31570 km, 2000
< ha <
31570 km. */
MEO
(
"Medium Earth Orbit"
),
/** MEO-GEO Crossing Orbit, 2000
< hp <
31570 km, 31570
< ha <
40002 km. */
/** MEO-GEO Crossing Orbit, 2000
< hp <
31570 km, 31570
< ha <
40002 km. */
MGO
(
"MEO-GEO Crossing Orbit"
),
/** Navigation Satellites Orbit 50°
< i <
70°, 18100
< hp <
24300 km, 18100
< ha <
4300 km. */
/** Navigation Satellites Orbit 50°
< i <
70°, 18100
< hp <
24300 km, 18100
< ha <
4300 km. */
NSO
(
"Navigation Satellites Orbit"
),
/** UFO: Undefined Orbit. */
...
...
src/main/java/org/orekit/files/ccsds/ndm/odm/oem/EphemerisWriter.java
View file @
725b8d85
...
...
@@ -77,7 +77,7 @@ public class EphemerisWriter implements EphemerisFileWriter {
* as new segments are written (with at least the segment start and stop will change,
* but some other parts may change too). The {@code template} argument itself is not
* changed.
* </>
* </
p
>
* @param writer underlying writer
* @param header file header (may be null)
* @param template template for metadata
...
...
src/main/java/org/orekit/files/ccsds/ndm/odm/oem/OemWriter.java
View file @
725b8d85
...
...
@@ -213,7 +213,7 @@ public class OemWriter extends AbstractMessageWriter<Header, OemSegment, Oem> {
* as new segments are written (with at least the segment start and stop will change,
* but some other parts may change too). The {@code template} argument itself is not
* changed.
* </>
* </
p
>
* <p>
* Calling this constructor directly is not recommended. Users should rather use
* {@link org.orekit.files.ccsds.ndm.WriterBuilder#buildOemWriter()
...
...
src/main/java/org/orekit/files/ccsds/ndm/tdm/Observation.java
View file @
725b8d85
...
...
@@ -20,7 +20,7 @@ package org.orekit.files.ccsds.ndm.tdm;
import
org.orekit.time.AbsoluteDate
;
/** The Observation class contains the data from an observation line.
<p>
/** The Observation class contains the data from an observation line.
* <p>
* It is not an Orekit object yet. It is a simple container holding:
* </p>
...
...
src/main/java/org/orekit/files/ccsds/utils/lexical/ParseToken.java
View file @
725b8d85
...
...
@@ -50,7 +50,6 @@ import org.orekit.utils.units.Unit;
* <li>bloc or entry end</li>
* <li>raw lines</li>
* </ul>
* </p>
* @see MessageParser
* @author Luc Maisonobe
* @since 11.0
...
...
@@ -688,7 +687,7 @@ public class ParseToken {
}
/** Interface representing instance methods that consume enum values.
* <T> type of the enum
*
@param
<T> type of the enum
*/
public
interface
EnumConsumer
<
T
extends
Enum
<
T
>>
{
/** Consume an enum.
...
...
@@ -698,7 +697,7 @@ public class ParseToken {
}
/** Interface representing instance methods that consume lists of enum values.
* <T> type of the enum
*
@param
<T> type of the enum
*/
public
interface
EnumListConsumer
<
T
extends
Enum
<
T
>>
{
/** Consume an enum.
...
...
src/main/java/org/orekit/files/ccsds/utils/lexical/TokenType.java
View file @
725b8d85
...
...
@@ -24,7 +24,6 @@ package org.orekit.files.ccsds.utils.lexical;
* <li>entry content</li>
* <li>bloc end</li>
* </ul>
* </p>
* @see ParseToken
* @author Luc Maisonobe
* @since 11.0
...
...
src/main/java/org/orekit/frames/LOFType.java
View file @
725b8d85
...
...
@@ -42,7 +42,6 @@ public enum LOFType {
* <li>Y<sub>TNW</sub> = -Z<sub>VNC</sub> = -X<sub>NTW</sub></li>
* <li>Z<sub>TNW</sub> = Y<sub>VNC</sub> = Z<sub>NTW</sub></li>
* </ul>
* </p>
*
* @see #VNC
* @see #NTW
...
...
@@ -77,7 +76,6 @@ public enum LOFType {
* <li>Y<sub>QSW/LVLH</sub> = X<sub>VVLH</sub></li>
* <li>Z<sub>QSW/LVLH</sub> = -Y<sub>VVLH</sub></li>
* </ul>
* </p>
*
* @see #LVLH
* @see #VVLH
...
...
@@ -118,7 +116,6 @@ public enum LOFType {
* <li>Y<sub>LVLH/QSW</sub> = X<sub>LVLH_CCSDS</sub></li>
* <li>Z<sub>LVLH/QSW</sub> = -Y<sub>LVLH_CCSDS</sub></li>
* </ul>
* </p>
*
* @see #QSW
* @see #VVLH
...
...
@@ -156,7 +153,6 @@ public enum LOFType {
* <li>Y<sub>LVLH_CCSDS/VVLH</sub> = -Z<sub>QSW/LVLH</sub></li>
* <li>Z<sub>LVLH_CCSDS/VVLH</sub> = -X<sub>QSW/LVLH</sub></li>
* </ul>
* </p>
*
* @see #QSW
* @see #LVLH
...
...
@@ -224,7 +220,6 @@ public enum LOFType {
* <li>Y<sub>VNC</sub> = Z<sub>TNW</sub> = Z<sub>NTW</sub></li>
* <li>Z<sub>VNC</sub> = -Y<sub>TNW</sub> = X<sub>NTW</sub></li>
* </ul>
* </p>
*
* @see #TNW
* @see #NTW
...
...
@@ -282,7 +277,6 @@ public enum LOFType {
* <li>Y<sub>NTW</sub> = X<sub>TNW</sub> = X<sub>VNC</sub></li>
* <li>Z<sub>NTW</sub> = Z<sub>TNW</sub> = Y<sub>VNC</sub></li>
* </ul>
* </p>
* @see #TNW
* @see #VNC
* @since 11.0
...
...
src/main/java/org/orekit/gnss/metric/messages/rtcm/ephemeris/Rtcm1019Data.java
View file @
725b8d85
...
...
@@ -172,7 +172,7 @@ public class Rtcm1019Data extends RtcmEphemerisData {
/**
* Set the GPS fit interval.
* @param gpsFitInterval
* @param gpsFitInterval
the GPS fit interval to set
*/
public
void
setGpsFitInterval
(
final
int
gpsFitInterval
)
{
this
.
gpsFitInterval
=
gpsFitInterval
;
...
...
src/main/java/org/orekit/gnss/metric/messages/rtcm/ephemeris/Rtcm1044Data.java
View file @
725b8d85
...
...
@@ -147,7 +147,7 @@ public class Rtcm1044Data extends RtcmEphemerisData {
/**
* Set the QZSS fit interval.
* @param qzssFitInterval
* @param qzssFitInterval
the QZSS fit interval to set
*/
public
void
setQzssFitInterval
(
final
int
qzssFitInterval
)
{
this
.
qzssFitInterval
=
qzssFitInterval
;
...
...
src/main/java/org/orekit/gnss/metric/ntrip/NtripClient.java
View file @
725b8d85
...
...
@@ -49,8 +49,8 @@ import org.orekit.gnss.metric.messages.ParsedMessage;
/** Source table for ntrip streams retrieval.
* <p>
* Note that all authentication is performed automatically by just
* calling the standard {@link
java.net.Authenticator
Authenticator#setDefault(Authenticator)
*
Authenticator.setDefault(someAuthenticator)}
method to set up an authenticator.
* calling the standard {@link Authenticator#setDefault(Authenticator)
}
* method to set up an authenticator.
* </p>
* @author Luc Maisonobe
* @since 11.0
...
...
src/main/java/org/orekit/propagation/analytical/gnss/data/SBASNavigationMessage.java
View file @
725b8d85
...
...
@@ -58,7 +58,7 @@ public class SBASNavigationMessage extends AbstractEphemerisMessage implements S
/**
* Setter for the reference time of the SBAS orbit in GPS seconds of the week.
* @param time
* @param time
the time to set
*/
public
void
setTime
(
final
double
time
)
{
this
.
time
=
time
;
...
...
src/main/java/org/orekit/time/DateTimeComponents.java
View file @
725b8d85
...
...
@@ -260,7 +260,7 @@ public class DateTimeComponents implements Serializable, Comparable<DateTimeComp
* @param minuteDuration 60, 61, or 62 seconds depending on the date being close to a
* leap second introduction and the magnitude of the leap
* second.
* @return string representation of this date, time,
&
UTC offset
* @return string representation of this date, time,
and
UTC offset
* @see #toString(int, int)
*/
public
String
toString
(
final
int
minuteDuration
)
{
...
...
@@ -276,10 +276,10 @@ public class DateTimeComponents implements Serializable, Comparable<DateTimeComp
* to a leap second introduction and the magnitude of the leap
* second.
* @param fractionDigits the number of digits to include after the decimal point in
* the string representation of the seconds. The date
&
time
is
* first rounded as necessary. {@code fractionDigits} must
be
* greater than or equal to {@code 0}.
* @return string representation of this date, time,
&
UTC offset
* the string representation of the seconds. The date
and
time
*
is
first rounded as necessary. {@code fractionDigits} must
*
be
greater than or equal to {@code 0}.
* @return string representation of this date, time,
and
UTC offset
* @see #toStringRfc3339()
* @see #toStringWithoutUtcOffset()
* @since 11.0
...
...
Prev
1
2
Next
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment