big changes in Doxygen configuration; work around bug with doxygen parsing of

initialized enum values showing the last word the initializer instead of the actual
enum value's name; add some more docs.

5 files changed, 87 insertions, 22 deletions

diff --git a/Eigen/src/Array/AllAndAny.h b/Eigen/src/Array/AllAndAny.h
index 74fbf38c9..4da017c6e 100644
--- a/Eigen/src/Array/AllAndAny.h
+++ b/Eigen/src/Array/AllAndAny.h
@@ -77,7 +77,9 @@ struct ei_any_unroller<Derived, Dynamic>
   inline static bool run(const Derived &) { return false; }
 };
 
-/** \returns true if all coefficients are true
+/** \array_module
+  * 
+  * \returns true if all coefficients are true
   *
   * \sa MatrixBase::any()
   */
@@ -99,7 +101,9 @@ bool MatrixBase<Derived>::all(void) const
   }
 }
 
-/** \returns true if at least one coefficient is true
+/** \array_module
+  * 
+  * \returns true if at least one coefficient is true
   *
   * \sa MatrixBase::any()
   */
diff --git a/Eigen/src/Array/CwiseOperators.h b/Eigen/src/Array/CwiseOperators.h
index f9f9e1267..d1f34b0e3 100644
--- a/Eigen/src/Array/CwiseOperators.h
+++ b/Eigen/src/Array/CwiseOperators.h
@@ -27,7 +27,9 @@
 
 // -- unary operators --
 
-/** \returns an expression of the coefficient-wise square root of *this. */
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise square root of *this. */
 template<typename Derived>
 inline const CwiseUnaryOp<ei_scalar_sqrt_op<typename ei_traits<Derived>::Scalar>, Derived>
 MatrixBase<Derived>::cwiseSqrt() const
@@ -35,7 +37,9 @@ MatrixBase<Derived>::cwiseSqrt() const
   return derived();
 }
 
-/** \returns an expression of the coefficient-wise exponential of *this. */
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise exponential of *this. */
 template<typename Derived>
 inline const CwiseUnaryOp<ei_scalar_exp_op<typename ei_traits<Derived>::Scalar>, Derived>
 MatrixBase<Derived>::cwiseExp() const
@@ -43,7 +47,9 @@ MatrixBase<Derived>::cwiseExp() const
   return derived();
 }
 
-/** \returns an expression of the coefficient-wise logarithm of *this. */
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise logarithm of *this. */
 template<typename Derived>
 inline const CwiseUnaryOp<ei_scalar_log_op<typename ei_traits<Derived>::Scalar>, Derived>
 MatrixBase<Derived>::cwiseLog() const
@@ -51,7 +57,9 @@ MatrixBase<Derived>::cwiseLog() const
   return derived();
 }
 
-/** \returns an expression of the coefficient-wise cosine of *this. */
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise cosine of *this. */
 template<typename Derived>
 inline const CwiseUnaryOp<ei_scalar_cos_op<typename ei_traits<Derived>::Scalar>, Derived>
 MatrixBase<Derived>::cwiseCos() const
@@ -59,7 +67,9 @@ MatrixBase<Derived>::cwiseCos() const
   return derived();
 }
 
-/** \returns an expression of the coefficient-wise sine of *this. */
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise sine of *this. */
 template<typename Derived>
 inline const CwiseUnaryOp<ei_scalar_sin_op<typename ei_traits<Derived>::Scalar>, Derived>
 MatrixBase<Derived>::cwiseSin() const
@@ -67,7 +77,9 @@ MatrixBase<Derived>::cwiseSin() const
   return derived();
 }
 
-/** \returns an expression of the coefficient-wise power of *this to the given exponent. */
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise power of *this to the given exponent. */
 template<typename Derived>
 inline const CwiseUnaryOp<ei_scalar_pow_op<typename ei_traits<Derived>::Scalar>, Derived>
 MatrixBase<Derived>::cwisePow(const Scalar& exponent) const
@@ -76,7 +88,9 @@ MatrixBase<Derived>::cwisePow(const Scalar& exponent) const
     (derived(), ei_scalar_pow_op<Scalar>(exponent));
 }
 
-/** \returns an expression of the coefficient-wise reciprocal of *this. */
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise reciprocal of *this. */
 template<typename Derived>
 inline const CwiseUnaryOp<ei_scalar_inverse_op<typename ei_traits<Derived>::Scalar>, Derived>
 MatrixBase<Derived>::cwiseInverse() const
@@ -86,7 +100,9 @@ MatrixBase<Derived>::cwiseInverse() const
 
 // -- binary operators --
 
-/** \returns an expression of the coefficient-wise \< operator of *this and \a other
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise \< operator of *this and \a other
   *
   * \sa class CwiseBinaryOp
   */
@@ -98,7 +114,9 @@ MatrixBase<Derived>::cwiseLessThan(const MatrixBase<OtherDerived> &other) const
   return cwise(other, std::less<Scalar>());
 }
 
-/** \returns an expression of the coefficient-wise \<= operator of *this and \a other
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise \<= operator of *this and \a other
   *
   * \sa class CwiseBinaryOp
   */
@@ -110,7 +128,9 @@ MatrixBase<Derived>::cwiseLessEqual(const MatrixBase<OtherDerived> &other) const
   return cwise(other, std::less_equal<Scalar>());
 }
 
-/** \returns an expression of the coefficient-wise \> operator of *this and \a other
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise \> operator of *this and \a other
   *
   * \sa class CwiseBinaryOp
   */
@@ -122,7 +142,9 @@ MatrixBase<Derived>::cwiseGreaterThan(const MatrixBase<OtherDerived> &other) con
   return cwise(other, std::greater<Scalar>());
 }
 
-/** \returns an expression of the coefficient-wise \>= operator of *this and \a other
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise \>= operator of *this and \a other
   *
   * \sa class CwiseBinaryOp
   */
@@ -134,7 +156,9 @@ MatrixBase<Derived>::cwiseGreaterEqual(const MatrixBase<OtherDerived> &other) co
   return cwise(other, std::greater_equal<Scalar>());
 }
 
-/** \returns an expression of the coefficient-wise == operator of *this and \a other
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise == operator of *this and \a other
   *
   * \sa class CwiseBinaryOp
   */
@@ -146,7 +170,9 @@ MatrixBase<Derived>::cwiseEqualTo(const MatrixBase<OtherDerived> &other) const
   return cwise(other, std::equal_to<Scalar>());
 }
 
-/** \returns an expression of the coefficient-wise != operator of *this and \a other
+/** \array_module
+  * 
+  * \returns an expression of the coefficient-wise != operator of *this and \a other
   *
   * \sa class CwiseBinaryOp
   */
diff --git a/Eigen/src/Array/Functors.h b/Eigen/src/Array/Functors.h
index 3169106d8..3452ddc94 100644
--- a/Eigen/src/Array/Functors.h
+++ b/Eigen/src/Array/Functors.h
@@ -26,6 +26,9 @@
 #define EIGEN_ARRAY_FUNCTORS_H
 
 /** \internal
+  *
+  * \array_module
+  * 
   * \brief Template functor to compute the square root of a scalar
   *
   * \sa class CwiseUnaryOp, MatrixBase::cwiseSqrt()
@@ -38,6 +41,9 @@ struct ei_functor_traits<ei_scalar_sqrt_op<Scalar> >
 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, IsVectorizable = false }; };
 
 /** \internal
+  *
+  * \array_module
+  * 
   * \brief Template functor to compute the exponential of a scalar
   *
   * \sa class CwiseUnaryOp, MatrixBase::cwiseExp()
@@ -50,6 +56,9 @@ struct ei_functor_traits<ei_scalar_exp_op<Scalar> >
 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, IsVectorizable = false }; };
 
 /** \internal
+  *
+  * \array_module
+  * 
   * \brief Template functor to compute the logarithm of a scalar
   *
   * \sa class CwiseUnaryOp, MatrixBase::cwiseLog()
@@ -62,6 +71,9 @@ struct ei_functor_traits<ei_scalar_log_op<Scalar> >
 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, IsVectorizable = false }; };
 
 /** \internal
+  *
+  * \array_module
+  * 
   * \brief Template functor to compute the cosine of a scalar
   *
   * \sa class CwiseUnaryOp, MatrixBase::cwiseCos()
@@ -74,6 +86,9 @@ struct ei_functor_traits<ei_scalar_cos_op<Scalar> >
 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, IsVectorizable = false }; };
 
 /** \internal
+  *
+  * \array_module
+  * 
   * \brief Template functor to compute the sine of a scalar
   *
   * \sa class CwiseUnaryOp, MatrixBase::cwiseSin()
@@ -86,6 +101,9 @@ struct ei_functor_traits<ei_scalar_sin_op<Scalar> >
 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, IsVectorizable = false }; };
 
 /** \internal
+  *
+  * \array_module
+  * 
   * \brief Template functor to raise a scalar to a power
   *
   * \sa class CwiseUnaryOp, MatrixBase::cwisePow
@@ -101,6 +119,9 @@ struct ei_functor_traits<ei_scalar_pow_op<Scalar> >
 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, IsVectorizable = false }; };
 
 /** \internal
+  *
+  * \array_module
+  * 
   * \brief Template functor to compute the reciprocal of a scalar
   *
   * \sa class CwiseUnaryOp, MatrixBase::cwiseInverse
diff --git a/Eigen/src/Array/PartialRedux.h b/Eigen/src/Array/PartialRedux.h
index 6b33caaa9..aa85b6ac0 100644
--- a/Eigen/src/Array/PartialRedux.h
+++ b/Eigen/src/Array/PartialRedux.h
@@ -26,7 +26,9 @@
 #ifndef EIGEN_PARTIAL_REDUX_H
 #define EIGEN_PARTIAL_REDUX_H
 
-/** \class PartialRedux
+/** \array_module
+  * 
+  * \class PartialRedux
   *
   * \brief Generic expression of a partially reduxed matrix
   *
@@ -93,7 +95,9 @@ class PartialRedux : ei_no_assignment_operator,
     const BinaryOp m_functor;
 };
 
-/** \returns a row vector expression of *this vertically reduxed by \a func
+/** \array_module
+  * 
+  * \returns a row vector expression of *this vertically reduxed by \a func
   *
   * The template parameter \a BinaryOp is the type of the functor
   * of the custom redux operator. Note that func must be an associative operator.
@@ -108,7 +112,9 @@ MatrixBase<Derived>::verticalRedux(const BinaryOp& func) const
   return PartialRedux<Vertical, BinaryOp, Derived>(derived(), func);
 }
 
-/** \returns a row vector expression of *this horizontally reduxed by \a func
+/** \array_module
+  * 
+  * \returns a row vector expression of *this horizontally reduxed by \a func
   *
   * The template parameter \a BinaryOp is the type of the functor
   * of the custom redux operator. Note that func must be an associative operator.
diff --git a/Eigen/src/Array/Random.h b/Eigen/src/Array/Random.h
index 2e19e1ff0..5a0f0814b 100644
--- a/Eigen/src/Array/Random.h
+++ b/Eigen/src/Array/Random.h
@@ -33,7 +33,9 @@ template<typename Scalar>
 struct ei_functor_traits<ei_scalar_random_op<Scalar> >
 { enum { Cost = 5 * NumTraits<Scalar>::MulCost, IsVectorizable = false, IsRepeatable = false }; };
 
-/** \returns a random matrix (not an expression, the matrix is immediately evaluated).
+/** \array_module
+  * 
+  * \returns a random matrix (not an expression, the matrix is immediately evaluated).
   *
   * The parameters \a rows and \a cols are the number of rows and of columns of
   * the returned matrix. Must be compatible with this MatrixBase type.
@@ -54,7 +56,9 @@ MatrixBase<Derived>::random(int rows, int cols)
   return create(rows, cols, ei_scalar_random_op<Scalar>());
 }
 
-/** \returns a random vector (not an expression, the vector is immediately evaluated).
+/** \array_module
+  * 
+  * \returns a random vector (not an expression, the vector is immediately evaluated).
   *
   * The parameter \a size is the size of the returned vector.
   * Must be compatible with this MatrixBase type.
@@ -77,7 +81,9 @@ MatrixBase<Derived>::random(int size)
   return create(size, ei_scalar_random_op<Scalar>());
 }
 
-/** \returns a fixed-size random matrix or vector
+/** \array_module
+  * 
+  * \returns a fixed-size random matrix or vector
   * (not an expression, the matrix is immediately evaluated).
   *
   * This variant is only for fixed-size MatrixBase types. For dynamic-size types, you
@@ -95,7 +101,9 @@ MatrixBase<Derived>::random()
   return create(RowsAtCompileTime, ColsAtCompileTime, ei_scalar_random_op<Scalar>());
 }
 
-/** Sets all coefficients in this expression to random values.
+/** \array_module
+  * 
+  * Sets all coefficients in this expression to random values.
   *
   * Example: \include MatrixBase_setRandom.cpp
   * Output: \verbinclude MatrixBase_setRandom.out