From 41c3a2ffc105812e81f8bef81e09e7099d36f9bd Mon Sep 17 00:00:00 2001
From: Gael Guennebaud <g.gael@free.fr>
Date: Tue, 25 Sep 2018 16:35:44 +0200
Subject: Fix documentation of reshape to vectors.

---
 Eigen/src/plugins/ReshapedMethods.h | 30 +++++++++---------------------
 1 file changed, 9 insertions(+), 21 deletions(-)

(limited to 'Eigen/src/plugins')

diff --git a/Eigen/src/plugins/ReshapedMethods.h b/Eigen/src/plugins/ReshapedMethods.h
index 5366e2711..574eb987b 100644
--- a/Eigen/src/plugins/ReshapedMethods.h
+++ b/Eigen/src/plugins/ReshapedMethods.h
@@ -25,7 +25,7 @@
 /// AutoSize does preserve compile-time sizes when possible, i.e., when the sizes of the input are known at compile time \b and
 /// that the other size is passed at compile-time using Eigen::fix<N> as above.
 ///
-/// \sa operator()(all), class Reshaped, fix, fix<N>(int)
+/// \sa class Reshaped, fix, fix<N>(int)
 ///
 template<int Order = ColMajor, typename NRowsType, typename NColsType>
 EIGEN_DEVICE_FUNC
@@ -40,22 +40,24 @@ reshaped(NRowsType nRows, NColsType nCols) const;
 
 /// \returns an expression of \c *this with columns (or rows) stacked to a linear column (or row) vector
 ///
-/// \tparam Order specifies whether to glue columns or rows, and returns a column or row vector.
-///               Possible values are ColMajor, RowMajor or AutoOrder. The default is ColMajor.
+/// \tparam Order specifies whether to stack columns to a column-vector (ColMajor) or
+///               to cat rows to a row-vector (RowMajor). The default is ColMajor.
 ///
 /// If Order==ColMajor (the default), then it returns a column vector from the stacked columns of \c *this.
-/// This is equivalent to \code A(all) \endcode and \code A.reshaped<RowMajor>(fix<1>,AutoSize) \endcode.
+/// This is equivalent to `A.reshaped<ColMajor>(AutoSize,fix<1>)`.
 ///
 /// If Order==RowMajor, then it returns a row vector from the glued rows of \c *this.
-/// This is equivalent to \code A.reshaped<RowMajor>(fix<1>,AutoSize) \endcode.
+/// This is equivalent to `A.reshaped<RowMajor>(fix<1>,AutoSize)`.
 ///
-/// If Order=AutoOrder, the it returns the same expression as \code A.reshaped<storage_order_of_A>() \endcode
+/// Example:
+/// \include MatrixBase_reshaped_to_vector.cpp
+/// Output: \verbinclude MatrixBase_reshaped_to_vector.out
 ///
 /// If you want more control, you can still fall back to reshaped(NRowsType,NColsType).
 /// For instance, to return a column vector with element stacked following the storage order,
 /// you can do: \code A.reshaped<AutoOrder>(AutoSize,fix<1>) \endcode
 ///
-/// \sa operator()(all), reshaped(NRowsType,NColsType), class Reshaped
+/// \sa reshaped(NRowsType,NColsType), class Reshaped
 ///
 template<int Order = ColMajor>
 EIGEN_DEVICE_FUNC
@@ -68,20 +70,6 @@ EIGEN_DEVICE_FUNC
 inline const Reshaped<const Derived,...>
 reshaped() const;
 
-/// \returns as expression of \c *this with columns stacked to a linear column vector
-///
-/// This overload is essentially a shortcut for
-/// \code this->reshape(AutoSize,fix<1>) \endcode
-///
-/// Example:
-/// \include MatrixBase_reshaped_all.cpp
-/// Output: \verbinclude MatrixBase_reshaped_all.out
-///
-/// \sa reshaped()
-EIGEN_DEVICE_FUNC
-inline Reshaped<Derived,SizeAtCompileTime,1>
-operator()(all);
-
 #else
 
 // This file is automatically included twice to generate const and non-const versions
-- 
cgit v1.2.3