diff options
author | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2011-09-07 04:19:12 +0100 |
---|---|---|
committer | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2011-09-07 04:19:12 +0100 |
commit | 7898281b2b29fcb74fe9b78d9382e6ca91c25f5d (patch) | |
tree | f4bdb5994f8e393eceebea0451ff574f20e43459 | |
parent | b38d3b360e6d138e51e6d2bf5fd8a3dcd9aa111c (diff) |
Put docs for unsupported modules in right place.
Doxygen was confused by the unsupported modules being partly in the doc/
directly, instead of completely in unsupported/doc/ . Thus, the link to
the unsupported modules on the server did not work (I think this manifested
itself after doxygen was upgraded on the server).
-rw-r--r-- | doc/unsupported_modules.dox | 64 | ||||
-rw-r--r-- | unsupported/Eigen/MPRealSupport | 3 | ||||
-rw-r--r-- | unsupported/doc/Overview.dox | 11 |
3 files changed, 12 insertions, 66 deletions
diff --git a/doc/unsupported_modules.dox b/doc/unsupported_modules.dox deleted file mode 100644 index 1d303c25e..000000000 --- a/doc/unsupported_modules.dox +++ /dev/null @@ -1,64 +0,0 @@ - -namespace Eigen { - -/** \defgroup Unsupported_modules Unsupported modules - * - * The unsupported modules are contributions from various users. They are - * provided "as is", without any support. Nevertheless, some of them are - * subject to be included in Eigen in the future. - */ - -// please list here all unsupported modules - -/** \ingroup Unsupported_modules - * \defgroup AdolcForward_Module */ - -/** \ingroup Unsupported_modules - * \defgroup AlignedVector3_Module */ - -/** \ingroup Unsupported_modules - * \defgroup AutoDiff_Module */ - -/** \ingroup Unsupported_modules - * \defgroup BVH_Module */ - -/** \ingroup Unsupported_modules - * \defgroup FFT_Module */ - -/** \ingroup Unsupported_modules - * \defgroup IterativeSolvers_Module */ - -/** \ingroup Unsupported_modules - * \defgroup MatrixFunctions_Module */ - -/** \ingroup Unsupported_modules - * \defgroup MoreVectorization */ - -/** \ingroup Unsupported_modules - * \defgroup NonLinearOptimization_Module */ - -/** \ingroup Unsupported_modules - * \defgroup NumericalDiff_Module */ - -/** \ingroup Unsupported_modules - * \defgroup Polynomials_Module */ - -/** \ingroup Unsupported_modules - * \defgroup Skyline_Module */ - -/** \ingroup Unsupported_modules - * \defgroup CholmodSupport_Module */ - -/** \ingroup Unsupported_modules - * \defgroup SuperLUSupport_Module */ - -/** \ingroup Unsupported_modules - * \defgroup UmfPackSupport_Module */ - -/** \ingroup Unsupported_modules - * \defgroup SparseExtra_Module */ - -/** \ingroup Unsupported_modules - * \defgroup MpfrcxxSupport_Module */ - -} // namespace Eigen diff --git a/unsupported/Eigen/MPRealSupport b/unsupported/Eigen/MPRealSupport index 8f6132946..44d75856e 100644 --- a/unsupported/Eigen/MPRealSupport +++ b/unsupported/Eigen/MPRealSupport @@ -36,7 +36,8 @@ namespace Eigen { - /** \defgroup MPRealSupport_Module MPFRC++ Support module + /** \ingroup Unsupported_modules + * \defgroup MPRealSupport_Module MPFRC++ Support module * * \code * #include <Eigen/MPRealSupport> diff --git a/unsupported/doc/Overview.dox b/unsupported/doc/Overview.dox index c09f06857..458b507b5 100644 --- a/unsupported/doc/Overview.dox +++ b/unsupported/doc/Overview.dox @@ -1,13 +1,22 @@ namespace Eigen { -o /** \mainpage Eigen's unsupported modules +/** \mainpage Eigen's unsupported modules This is the API documentation for Eigen's unsupported modules. These modules are contributions from various users. They are provided "as is", without any support. +Click on the \e Modules tab at the top of this page to get a list of all unsupported modules. + Don't miss the <a href="..//index.html">official Eigen documentation</a>. + +\defgroup Unsupported_modules Unsupported modules + +The unsupported modules are contributions from various users. They are +provided "as is", without any support. Nevertheless, some of them are +subject to be included in Eigen in the future. + */ } |