diff options
author | Benoit Jacob <jacob.benoit.1@gmail.com> | 2011-02-11 09:55:54 -0500 |
---|---|---|
committer | Benoit Jacob <jacob.benoit.1@gmail.com> | 2011-02-11 09:55:54 -0500 |
commit | f7e4602a40fc5425f8832fc849311fd68f24034f (patch) | |
tree | 86c218c15b092df754c83adc4637b5d0707fdc15 /doc | |
parent | bf79a3199c87ccfa254b3e4a4111888c010f2c52 (diff) |
doc fixes
Diffstat (limited to 'doc')
-rw-r--r-- | doc/A05_PortingFrom2To3.dox | 2 | ||||
-rw-r--r-- | doc/A10_Eigen2SupportModes.dox | 12 |
2 files changed, 7 insertions, 7 deletions
diff --git a/doc/A05_PortingFrom2To3.dox b/doc/A05_PortingFrom2To3.dox index 70a8d09b4..d78e2df34 100644 --- a/doc/A05_PortingFrom2To3.dox +++ b/doc/A05_PortingFrom2To3.dox @@ -29,7 +29,7 @@ In order to ease the switch from Eigen2 to Eigen3, Eigen3 features \ref Eigen2Su The quick way to enable this is to define the \c EIGEN2_SUPPORT preprocessor token \b before including any Eigen header (typically it should be set in your project options). -A more powerful, \em staged migration path is also provided, which may be useful to migrate larger projects from Eigen2 to Eigen3. This explained in the \ref Eigen2SupportModes "Eigen 2 support modes" page. +A more powerful, \em staged migration path is also provided, which may be useful to migrate larger projects from Eigen2 to Eigen3. This is explained in the \ref Eigen2SupportModes "Eigen 2 support modes" page. \section Using The USING_PART_OF_NAMESPACE_EIGEN macro diff --git a/doc/A10_Eigen2SupportModes.dox b/doc/A10_Eigen2SupportModes.dox index 0c698093a..0cad932d9 100644 --- a/doc/A10_Eigen2SupportModes.dox +++ b/doc/A10_Eigen2SupportModes.dox @@ -3,7 +3,7 @@ namespace Eigen { /** \page Eigen2SupportModes Eigen 2 support modes This page documents the Eigen2 support modes, a powerful tool to help migrating your project from Eigen 2 to Eigen 3. -Also don't miss our page on \ref Eigen2ToEigen3 "API changes" between Eigen 2 and Eigen 3. +Don't miss our page on \ref Eigen2ToEigen3 "API changes" between Eigen 2 and Eigen 3. \b Table \b of \b contents - \ref EIGEN2_SUPPORT_Macro @@ -30,9 +30,9 @@ The primary reason why EIGEN2_SUPPORT alone may not be enough to migrate a large It goes as follows: \li Step 0: start with a project using Eigen 2. \li Step 1: build your project against Eigen 3 with \ref Stage10 "Eigen 2 support stage 10". This mode enables maximum compatibility with the Eigen 2 API, with just a few exceptions. -\li Step 2: build your project against Eigen 3 with \ref Stage10 "Eigen 2 support stage 20". This mode forces you to add eigen2_ prefixes to the Eigen2 identifiers that conflict with Eigen 3 API. -\li Step 3: build your project against Eigen 3 with \ref Stage10 "Eigen 2 support stage 30". This mode enables the full Eigen 3 API. -\li Step 4: build your project against Eigen 3 with \ref Stage10 "Eigen 2 support stage 40". This mode enables the full Eigen 3 strictness on matters, such as const-correctness, where Eigen 2 was looser. +\li Step 2: build your project against Eigen 3 with \ref Stage20 "Eigen 2 support stage 20". This mode forces you to add eigen2_ prefixes to the Eigen2 identifiers that conflict with Eigen 3 API. +\li Step 3: build your project against Eigen 3 with \ref Stage30 "Eigen 2 support stage 30". This mode enables the full Eigen 3 API. +\li Step 4: build your project against Eigen 3 with \ref Stage40 "Eigen 2 support stage 40". This mode enables the full Eigen 3 strictness on matters, such as const-correctness, where Eigen 2 was looser. \li Step 5: build your project against Eigen 3 without any Eigen 2 support mode. \section Stage10 Stage 10: define EIGEN2_SUPPORT_STAGE10_FULL_EIGEN2_API @@ -64,7 +64,7 @@ Enable this mode by defining the EIGEN2_SUPPORT_STAGE30_FULL_EIGEN3_API preproce This mode gives you the full unaltered Eigen 3 API, while still keeping as much support as possible for the Eigen 2 API. -The eigen2_-prefixed identifiers are still available, but at this stage you should now replace them by Eigen 3 identifiers. +The eigen2_-prefixed identifiers are still available, but at this stage you should now replace them by Eigen 3 identifiers. Have a look at our page on \ref Eigen2ToEigen3 "API changes" between Eigen 2 and Eigen 3. \section Stage40 Stage 40: define EIGEN2_SUPPORT_STAGE40_FULL_EIGEN3_STRICTNESS @@ -84,7 +84,7 @@ This lets Eigen do the right thing for you and works equally well in Eigen 2 and \section FinallyDropAllEigen2Support Finally drop all Eigen 2 support -Stage 40 is the first where it's "comfortable" to stay for a little longer period, since it preserves 100% Eigen 3 compatibility. However, we still encourage you to complete your migration as quickly as possible. While we do run the Eigen 2 test suite against Eigen 3's stage 10 support mode, we can't guarantee the same level of support and quality assurance for Eigen 2 support as we do for Eigen 3 itself, especially not in the long term. +Stage 40 is the first where it's "comfortable" to stay for a little longer period, since it preserves 100% Eigen 3 compatibility. However, we still encourage you to complete your migration as quickly as possible. While we do run the Eigen 2 test suite against Eigen 3's stage 10 support mode, we can't guarantee the same level of support and quality assurance for Eigen 2 support as we do for Eigen 3 itself, especially not in the long term. \ref Eigen2ToEigen3 "This page" describes a large part of the changes that you may need to perform. \section ABICompatibility What about ABI compatibility? |