mirror/eigen
2
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-02-17 18:09:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Put docs for unsupported modules in right place.

Browse Source 
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).
This commit is contained in:
Jitse Niesen 2011-09-07 04:19:12 +01:00
parent b38d3b360e
commit 7898281b2b
3 changed files with 12 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
doc/unsupported_modules.dox
View File

@ -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

3
unsupported/Eigen/MPRealSupport
View File

@ -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>

11
unsupported/doc/Overview.dox
View File

@ -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.
*/
}