From 2612bbdf8bf31a2d9ae1d99e5aa57d1adf3ea634 Mon Sep 17 00:00:00 2001 From: Thomas Capricelli Date: Tue, 10 Nov 2009 22:02:10 +0100 Subject: [PATCH] make the complex module appear in doxygen + small documentation --- doc/unsupported_modules.dox | 3 +++ unsupported/Eigen/Complex | 13 ++++++++++++- unsupported/Eigen/FFT | 2 +- 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/doc/unsupported_modules.dox b/doc/unsupported_modules.dox index 455e80860..f606aca0a 100644 --- a/doc/unsupported_modules.dox +++ b/doc/unsupported_modules.dox @@ -22,6 +22,9 @@ namespace Eigen { /** \ingroup Unsupported_modules * \defgroup BVH_Module */ +/** \ingroup Unsupported_modules + * \defgroup Complex_Module */ + /** \ingroup Unsupported_modules * \defgroup FFT_Module */ diff --git a/unsupported/Eigen/Complex b/unsupported/Eigen/Complex index 04228c95a..1232782ad 100644 --- a/unsupported/Eigen/Complex +++ b/unsupported/Eigen/Complex @@ -28,7 +28,18 @@ // Eigen::Complex reuses as much as possible from std::complex // and allows easy conversion to and from, even at the pointer level. - +/** \ingroup Unsupported_modules + * \defgroup Complex_Module Complex module + * + * \code + * #include + * \endcode + * + * The C++ complex type has some severe limitations that prevent an + * optimal use within Eigen. This (still unsupported) module is an attempt + * to fix this. + */ + #include namespace Eigen { diff --git a/unsupported/Eigen/FFT b/unsupported/Eigen/FFT index c143ef5bb..c8521bbf0 100644 --- a/unsupported/Eigen/FFT +++ b/unsupported/Eigen/FFT @@ -35,7 +35,7 @@ * \defgroup FFT_Module Fast Fourier Transform module * * \code - * #include + * #include * \endcode * * This module provides Fast Fourier transformation, either using a built-in implementation