Commit cb6c0659 authored by Luc Maisonobe's avatar Luc Maisonobe
Browse files

Fixed javadoc warnings.

parent c8cf9c23
......@@ -67,11 +67,10 @@ public interface ForceModel {
/**
* Initialize the force model at the start of propagation. This method will be called
* before any calls to {@link #addContribution(SpacecraftState, TimeDerivativesEquations)},
* {@link #addContribution(FieldSpacecraftState, FieldTimeDerivativesEquations),
* {@link #acceleration(SpacecraftState)}, {@link #acceleration(FieldSpacecraftState)}
* or {@link #accelerationDerivatives(SpacecraftState, String)}
* {@link #addContribution(FieldSpacecraftState, FieldTimeDerivativesEquations)},
* {@link #acceleration(SpacecraftState, double[])} or {@link #acceleration(FieldSpacecraftState, RealFieldElement[])}
*
* <p> The default implementation of this method does nothing.
* <p> The default implementation of this method does nothing.</p>
*
* @param initialState spacecraft state at the start of propagation.
* @param target date of propagation. Not equal to {@code initialState.getDate()}.
......@@ -85,7 +84,7 @@ public interface ForceModel {
/** Compute the contribution of the force model to the perturbing
* acceleration.
* <p>
* The default implementation simply adds the {@link #acceleration(SpacecraftState) acceleration}
* The default implementation simply adds the {@link #acceleration(SpacecraftState, double[]) acceleration}
* as a non-Keplerian acceleration.
* </p>
* @param s current state information: date, kinematics, attitude
......
......@@ -59,9 +59,8 @@ import org.orekit.utils.ParameterDriver;
* </p>
* <p>
* This model directly uses normalized coefficients and stable recursion algorithms
* so it is more suited to high degree gravity fields than the classical {@link
* CunninghamAttractionModel Cunningham} or {@link DrozinerAttractionModel Droziner}
* models which use un-normalized coefficients.
* so it is more suited to high degree gravity fields than the classical Cunningham
* Droziner models which use un-normalized coefficients.
* </p>
* <p>
* Among the different algorithms presented in Holmes and Featherstone paper, this
......
......@@ -19,15 +19,13 @@
* This package provides all gravity-related forces.
*
* <p>
* The force models include several implementations of spherical harmonics
* attraction models: {@link org.orekit.forces.gravity.HolmesFeatherstoneAttractionModel Holmes-Featherstone},
* {@link org.orekit.forces.gravity.CunninghamAttractionModel Cunningham}, and {@link
* org.orekit.forces.gravity.DrozinerAttractionModel Droziner}.
* The recommended one is {@link org.orekit.forces.gravity.HolmesFeatherstoneAttractionModel Holmes-Featherstone}.</p>
* The force models include an implementation of spherical harmonics
* attraction model: {@link org.orekit.forces.gravity.HolmesFeatherstoneAttractionModel Holmes-Featherstone}.</p>
* <p>
* The force models also include {@link org.orekit.forces.gravity.ThirdBodyAttraction third body attraction},
* and both {@link org.orekit.forces.gravity.SolidTides solid tides} and {@link
* org.orekit.forces.gravity.OceanTides ocean tides}, both with or without pole tide.
* both {@link org.orekit.forces.gravity.SolidTides solid tides} and {@link
* org.orekit.forces.gravity.OceanTides ocean tides}, both with or without pole tide and
* {@link org.orekit.forces.gravity.Relativity post-Newtonian correction force due to general relativity}.
* </p>
*
* @author L. Maisonobe
......
......@@ -20,7 +20,8 @@ import org.orekit.errors.OrekitException;
import org.orekit.propagation.SpacecraftState;
/** Interface representing a vector function depending on {@link SpacecraftState}.
* @see Differentiation#differentiate(StateFunction, int, org.orekit.orbits.OrbitType, org.orekit.orbits.PositionAngle, double, int)
* @see Differentiation#differentiate(StateFunction, int, org.orekit.attitudes.AttitudeProvider,
* org.orekit.orbits.OrbitType, org.orekit.orbits.PositionAngle, double, int)
* @see StateJacobian
* @author Luc Maisonobe
* @since 8.0
......
......@@ -20,7 +20,8 @@ import org.orekit.errors.OrekitException;
import org.orekit.propagation.SpacecraftState;
/** Interface representing the Jacobian of a vector function depending on {@link SpacecraftState}.
* @see Differentiation#differentiate(StateFunction, int, org.orekit.orbits.OrbitType, org.orekit.orbits.PositionAngle, double, int)
* @see Differentiation#differentiate(StateFunction, int, org.orekit.attitudes.AttitudeProvider,
* org.orekit.orbits.OrbitType, org.orekit.orbits.PositionAngle, double, int)
* @see StateFunction
* @author Luc Maisonobe
* @since 8.0
......
Supports Markdown
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