From 785ea269eb22ebaa4e2fcd4542d456d3da2823bc Mon Sep 17 00:00:00 2001
From: Luc Maisonobe <luc@apache.org>
Date: Tue, 18 Feb 2014 15:11:46 +0000
Subject: [PATCH] Javadoc.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1569380 13f79535-47bb-0310-9956-ffa450edef68
---
 .../leastsquares/LeastSquaresProblem.java      | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/src/main/java/org/apache/commons/math3/fitting/leastsquares/LeastSquaresProblem.java b/src/main/java/org/apache/commons/math3/fitting/leastsquares/LeastSquaresProblem.java
index 9bfcb049a..f4217295c 100644
--- a/src/main/java/org/apache/commons/math3/fitting/leastsquares/LeastSquaresProblem.java
+++ b/src/main/java/org/apache/commons/math3/fitting/leastsquares/LeastSquaresProblem.java
@@ -20,10 +20,20 @@ import org.apache.commons.math3.linear.RealMatrix;
 import org.apache.commons.math3.linear.RealVector;
 
 /**
- * The data necessary to define a non-linear least squares problem. Includes the observed
- * values, computed model function, and convergence/divergence criteria. Weights are
- * implicit in {@link Evaluation#computeResiduals()} and {@link
- * Evaluation#computeJacobian()}.
+ * The data necessary to define a non-linear least squares problem.
+ * <p>
+ * Includes the observed values, computed model function, and
+ * convergence/divergence criteria. Weights are implicit in {@link
+ * Evaluation#computeResiduals()} and {@link Evaluation#computeJacobian()}.
+ * </p>
+ * <p>
+ * Instances are typically either created progressively using a {@link
+ * LeastSquaresBuilder builder} or created at once using a {@link LeastSquaresFactory
+ * factory}.
+ * </p>
+ * @see LeastSquaresBuilder
+ * @see LeastSquaresFactory
+ * @see LeastSquaresAdapter
  *
  * @version $Id$
  * @since 3.3