add javadoc

src/main/java/org/orekit/rugged/adjustment/GroundOptimizationProblemBuilder.java

@@ -46,8 +46,12 @@ import org.orekit.rugged.adjustment.measurements.Observables;
 import org.orekit.rugged.adjustment.measurements.SensorToGroundMapping;
 import org.orekit.utils.ParameterDriver;
 
-/** TODO GP description a completer.
+/** Ground optimization problem builder.
+ * builds the optimization problem relying on ground measurements.
  * @author Guylaine Prat
+ * @author Lucie Labat Allee
+ * @author Jonathan Guinet
+ * @author Luc Maisonobe
  * @since 2.0
  */
 public class GroundOptimizationProblemBuilder extends OptimizationProblemBuilder {
@@ -74,7 +78,7 @@ public class GroundOptimizationProblemBuilder extends OptimizationProblemBuilder
     private HashMap<String, double[] > targetAndWeight;
 
 
-    /** TODO GP description a completer.
+    /** Build a new instance of the optimization problem.
      * @param sensors list of sensors to refine
      * @param measurements set of observables
      * @param rugged name of rugged to refine

src/main/java/org/orekit/rugged/adjustment/InterSensorsOptimizationProblemBuilder.java

@@ -49,9 +49,12 @@ import org.orekit.rugged.utils.SpacecraftToObservedBody;
 import org.orekit.time.AbsoluteDate;
 import org.orekit.utils.ParameterDriver;
 
-/** TODO GP description a completer.
- * @author ???
+/** InterSensorsOptimizationProblemBuilder 
+ * Constructs the optimization problem for a list of tie points.
  * @author Guylaine Prat
+ * @author Lucie Labat Allee
+ * @author Jonathan Guinet
+ * @author Luc Maisonobe
  * @since 2.0
  */
 public class InterSensorsOptimizationProblemBuilder extends OptimizationProblemBuilder {

src/main/java/org/orekit/rugged/adjustment/LeastSquareAdjuster.java

@@ -24,7 +24,8 @@ import org.hipparchus.optim.nonlinear.vector.leastsquares.LeastSquaresProblem;
 import org.hipparchus.optim.nonlinear.vector.leastsquares.LevenbergMarquardtOptimizer;
 import org.orekit.rugged.errors.RuggedException;
 
-/** TODO GP description a completer.
+/** LeastSquareAdjuster
+ * class for setting least square algorithm chosen for solving optimization problem.
  * @author Guylaine Prat
  * @since 2.0
  */

src/main/java/org/orekit/rugged/adjustment/OptimizationProblemBuilder.java

@@ -43,7 +43,7 @@ import org.orekit.utils.ParameterDriver;
 /**
  * Builder for optimization problem.
  * <p>
- * TODO GP description a completer
+ * Constructs the optimization problem defined by a set of measurement and sensors.
  * </p>
  * @author Jonathan Guinet
  * @author Guylaine Prat
@@ -111,7 +111,6 @@ abstract class OptimizationProblemBuilder {
     final ConvergenceChecker<LeastSquaresProblem.Evaluation>
                             createChecker(final double parametersConvergenceThreshold) {
 
-        // TODO GP description a completer
         final ConvergenceChecker<LeastSquaresProblem.Evaluation> checker = (iteration, previous, current)
             -> current.getPoint().getLInfDistance(previous.getPoint()) <= parametersConvergenceThreshold;
 
@@ -151,7 +150,6 @@ abstract class OptimizationProblemBuilder {
     final ParameterValidator createParameterValidator() {
 
         // Prevent parameters to exceed their prescribed bounds
-        // TODO GP description a completer
         final ParameterValidator validator = params -> {
             try {
                 int i = 0;
@@ -210,7 +208,7 @@ abstract class OptimizationProblemBuilder {
 
         final DSFactory factory = new DSFactory(map.size(), 1);
 
-        // TODO GP description a completer
+        // Derivative Structure Generator
         return new DSGenerator() {
 
             /** {@inheritDoc} */

src/main/java/org/orekit/rugged/adjustment/measurements/Observables.java

@@ -63,8 +63,10 @@ public class Observables {
         interMappings.put(this.createKey(interMapping), interMapping);
     }
 
-    /** Add a ground mapping between ????
-     * TODO GP commentaire a completer
+    /** Add a ground mapping 
+     * <p>
+     * a ground mapping is defined by a set of GCPs 
+     * </p>
      * @param groundMapping sensor to ground mapping
      */
     public void addGroundMapping(final SensorToGroundMapping groundMapping) {
@@ -92,7 +94,6 @@ public class Observables {
     }
 
     /** Get the sensor to sensor values.
-     * TODO GP commentaire a completer
      * @return the inter-mappings
      */
     public Collection<SensorToSensorMapping> getInterMappings() {
@@ -108,7 +109,9 @@ public class Observables {
 
     /**
      * Get a sensor mapping for a sensor.
-     * TODO GP commentaire a completer
+     * <p>
+     * returns sensor to sensor mapping associated with specific sensors and related rugged instance.
+     * </p>
      * @param ruggedNameA Rugged name A
      * @param sensorNameA sensor name A
      * @param ruggedNameB Rugged name B