aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/plugins
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2018-10-03 15:13:15 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2018-10-03 15:13:15 +0200
commit3e64b1fc8661316b20335cd287a726b4b37dff0c (patch)
tree5331e4aead7801d3111030a60dccbf59f12e8cdc /Eigen/src/plugins
parent8a1e98240e6ac9f3456953b9e0b220c803acf9ed (diff)
Move iterators to internal, improve doc, make unit test c++03 friendly
Diffstat (limited to 'Eigen/src/plugins')
-rw-r--r--Eigen/src/plugins/ReshapedMethods.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/Eigen/src/plugins/ReshapedMethods.h b/Eigen/src/plugins/ReshapedMethods.h
index ca9251ed2..2466d24cb 100644
--- a/Eigen/src/plugins/ReshapedMethods.h
+++ b/Eigen/src/plugins/ReshapedMethods.h
@@ -43,11 +43,11 @@ reshaped(NRowsType nRows, NColsType nCols) const;
/// \tparam Order specifies whether the coefficients should be processed in column-major-order (ColMajor), in row-major-order (RowMajor),
/// or follows the \em natural order of the nested expression (AutoOrder). The default is ColMajor.
///
-/// This overloads is essentially a shortcut for `A.reshaped<Order>(AutoSize,fix<1>).
+/// This overloads is essentially a shortcut for `A.reshaped<Order>(AutoSize,fix<1>)`.
///
-/// - If Order==ColMajor (the default), then it returns a column-vector from the stacked columns of \c *this.
-/// - If Order==RowMajor, then it returns a column-vector from the stacked rows of \c *this.
-/// - If Order==AutoOrder, then it returns a column-vector with elements stacked following the storage order of \c *this.
+/// - If `Order==ColMajor` (the default), then it returns a column-vector from the stacked columns of \c *this.
+/// - If `Order==RowMajor`, then it returns a column-vector from the stacked rows of \c *this.
+/// - If `Order==AutoOrder`, then it returns a column-vector with elements stacked following the storage order of \c *this.
/// This mode is the recommended one when the particular ordering of the element is not relevant.
///
/// Example: