diff options
author | Gael Guennebaud <g.gael@free.fr> | 2017-01-16 16:31:19 +0100 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2017-01-16 16:31:19 +0100 |
commit | 12e22a2844d060cfbeab7a48512046ee59709e53 (patch) | |
tree | 75f953480c10fccdca41bb536c64cb870081108b /Eigen/src/Core/util/IntegralConstant.h | |
parent | e70c4c97faf89b844dc9986e664257c9423c7ff6 (diff) |
typos in doc
Diffstat (limited to 'Eigen/src/Core/util/IntegralConstant.h')
-rw-r--r-- | Eigen/src/Core/util/IntegralConstant.h | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/Eigen/src/Core/util/IntegralConstant.h b/Eigen/src/Core/util/IntegralConstant.h index dc8c8413d..57538060c 100644 --- a/Eigen/src/Core/util/IntegralConstant.h +++ b/Eigen/src/Core/util/IntegralConstant.h @@ -124,15 +124,16 @@ static const auto fix; /** \fn fix(int) * \ingroup Core_Module * - * This function returns an object embedding both a compile-time integer \c N, and a runtime value \a val. + * This function returns an object embedding both a compile-time integer \c N, and a fallback runtime value \a val. * * \tparam N the compile-time integer value - * \param val the runtime integer value + * \param val the fallback runtime integer value * * This function is a more general version of the \ref fix identifier/function that can be used in template code - * where the compile-time value coudl turned out to actually mean "undefined at compile-time". For positive integers - * such as a size of a dimension, this case is identified by Eigen::Dynamic, whereas runtime signed integers (e.g., an increment/stride) are identified - * as Eigen::DynamicIndex. + * where the compile-time value could turn out to actually mean "undefined at compile-time". For positive integers + * such as a size or a dimension, this case is identified by Eigen::Dynamic, whereas runtime signed integers + * (e.g., an increment/stride) are identified as Eigen::DynamicIndex. In such a case, the runtime value \a val + * will be used as a fallback. * * A typical use case would be: * \code |