aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2009-01-26 13:53:43 +0000
committerGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2009-01-26 13:53:43 +0000
commita79deafc6dd6508d208603f6424c1e9458e27974 (patch)
tree2d921c2b650a56fb057452ceb82381b7854c3045 /doc
parent65e4ae4ff43307167881f96aa45450ff3f01df22 (diff)
* mark Geometry as experimental
* install QtAlignedMalloc * finish the renaming Regression->LeastSquares * install LeastSquares directory (!!!) * misc dox fixes
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile.in4
-rw-r--r--doc/Experimental.dox3
2 files changed, 4 insertions, 3 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index b30ffe0d8..873dd24bc 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -210,11 +210,11 @@ ALIASES = "only_for_vectors=This is only for vectors (either row-
"qr_module=This is defined in the %QR module. \code #include <Eigen/QR> \endcode" \
"svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \
"geometry_module=This is defined in the %Geometry module. \code #include <Eigen/Geometry> \endcode" \
- "regression_module=This is defined in the %Regression module. \code #include <Eigen/Regression> \endcode" \
+ "leastsquares_module=This is defined in the %LeastSquares module. \code #include <Eigen/LeastSquares> \endcode" \
"addexample=\anchor" \
"label=\bug" \
"redstar=<a href='#warningarraymodule' style='color:red;text-decoration: none;'>*</a>" \
- "nonstableyet=\warning This class/function is not considered to be part of the stable public API yet. Changes may happen in future releases. See \ref Experimental \"Experimental parts of Eigen\""
+ "nonstableyet=\warning This is not considered to be part of the stable public API yet. Changes may happen in future releases. See \ref Experimental \"Experimental parts of Eigen\""
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
diff --git a/doc/Experimental.dox b/doc/Experimental.dox
index f55a47f50..2191c2b2c 100644
--- a/doc/Experimental.dox
+++ b/doc/Experimental.dox
@@ -12,7 +12,7 @@ namespace Eigen {
Experimental features may at any time:
\li be removed;
\li be subject to an API incompatible change;
-\li introduce API or ABI incompatible changes in your own application if you let them affect your API or ABI.
+\li introduce API or ABI incompatible changes in your own code if you let them affect your API or ABI.
\section modules Experimental modules
@@ -20,6 +20,7 @@ The following modules are considered entirely experimental:
\li SVD
\li QR
\li Sparse
+\li Geometry
\section core Experimental parts of the Core module