aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/PardisoSupport
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2012-06-21 10:51:22 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2012-06-21 10:51:22 +0200
commit6f3057f624da32ee854ba13df2bb5e399050c8c4 (patch)
tree68eb512466a650d22db358b103894043414e4e9f /Eigen/PardisoSupport
parent5b5f3ecafa25aee1af27ea3503ad9e0e1ee49d04 (diff)
extend documentation of *Support modules
Diffstat (limited to 'Eigen/PardisoSupport')
-rw-r--r--Eigen/PardisoSupport6
1 files changed, 5 insertions, 1 deletions
diff --git a/Eigen/PardisoSupport b/Eigen/PardisoSupport
index 6585edb74..99330ce7a 100644
--- a/Eigen/PardisoSupport
+++ b/Eigen/PardisoSupport
@@ -12,11 +12,15 @@
/** \ingroup Support_modules
* \defgroup PardisoSupport_Module PardisoSupport module
*
- * This module brings support for the Intel(R) MKL PARDISO direct sparse solvers
+ * This module brings support for the Intel(R) MKL PARDISO direct sparse solvers.
*
* \code
* #include <Eigen/PardisoSupport>
* \endcode
+ *
+ * In order to use this module, the MKL headers must be accessible from the include paths, and your binary must be linked to the MKL library and its dependencies.
+ * See this \ref TopicUsingIntelMKL "page" for more information on MKL-Eigen integration.
+ *
*/
#include "src/PardisoSupport/PardisoSupport.h"