diff options
author | Eugene Zhulenev <ezhulenev@google.com> | 2019-04-24 12:42:28 -0700 |
---|---|---|
committer | Eugene Zhulenev <ezhulenev@google.com> | 2019-04-24 12:42:28 -0700 |
commit | 8ead5bb3d87d87c43e04b77ae2638298b24f4962 (patch) | |
tree | 545ce9bf39dc6459888f430cd8e1b7e2c3ba0a41 /Eigen/src/Core | |
parent | 144ca333219a043b2de87bca383f24b89308ba6f (diff) |
Fix doxygen warnings to enable statis code analysis
Diffstat (limited to 'Eigen/src/Core')
-rw-r--r-- | Eigen/src/Core/DenseBase.h | 6 | ||||
-rw-r--r-- | Eigen/src/Core/DenseCoeffsBase.h | 12 | ||||
-rw-r--r-- | Eigen/src/Core/EigenBase.h | 3 | ||||
-rw-r--r-- | Eigen/src/Core/TriangularMatrix.h | 8 |
4 files changed, 17 insertions, 12 deletions
diff --git a/Eigen/src/Core/DenseBase.h b/Eigen/src/Core/DenseBase.h index 9c53fd3ae..b92d73a72 100644 --- a/Eigen/src/Core/DenseBase.h +++ b/Eigen/src/Core/DenseBase.h @@ -302,17 +302,17 @@ template<typename Derived> class DenseBase Derived& operator=(const ReturnByValue<OtherDerived>& func); /** \internal - * Copies \a other into *this without evaluating other. \returns a reference to *this. - * \deprecated */ + * Copies \a other into *this without evaluating other. \returns a reference to *this. */ template<typename OtherDerived> + /** \deprecated */ EIGEN_DEPRECATED EIGEN_DEVICE_FUNC Derived& lazyAssign(const DenseBase<OtherDerived>& other); EIGEN_DEVICE_FUNC CommaInitializer<Derived> operator<< (const Scalar& s); - /** \deprecated it now returns \c *this */ template<unsigned int Added,unsigned int Removed> + /** \deprecated it now returns \c *this */ EIGEN_DEPRECATED const Derived& flagged() const { return derived(); } diff --git a/Eigen/src/Core/DenseCoeffsBase.h b/Eigen/src/Core/DenseCoeffsBase.h index c4af48ab6..463b471c8 100644 --- a/Eigen/src/Core/DenseCoeffsBase.h +++ b/Eigen/src/Core/DenseCoeffsBase.h @@ -22,7 +22,8 @@ template<typename T> struct add_const_on_value_type_if_arithmetic /** \brief Base class providing read-only coefficient access to matrices and arrays. * \ingroup Core_Module * \tparam Derived Type of the derived class - * \tparam #ReadOnlyAccessors Constant indicating read-only access + * + * \note #ReadOnlyAccessors Constant indicating read-only access * * This class defines the \c operator() \c const function and friends, which can be used to read specific * entries of a matrix or array. @@ -288,7 +289,8 @@ class DenseCoeffsBase<Derived,ReadOnlyAccessors> : public EigenBase<Derived> /** \brief Base class providing read/write coefficient access to matrices and arrays. * \ingroup Core_Module * \tparam Derived Type of the derived class - * \tparam #WriteAccessors Constant indicating read/write access + * + * \note #WriteAccessors Constant indicating read/write access * * This class defines the non-const \c operator() function and friends, which can be used to write specific * entries of a matrix or array. This class inherits DenseCoeffsBase<Derived, ReadOnlyAccessors> which @@ -466,7 +468,8 @@ class DenseCoeffsBase<Derived, WriteAccessors> : public DenseCoeffsBase<Derived, /** \brief Base class providing direct read-only coefficient access to matrices and arrays. * \ingroup Core_Module * \tparam Derived Type of the derived class - * \tparam #DirectAccessors Constant indicating direct access + * + * \note #DirectAccessors Constant indicating direct access * * This class defines functions to work with strides which can be used to access entries directly. This class * inherits DenseCoeffsBase<Derived, ReadOnlyAccessors> which defines functions to access entries read-only using @@ -539,7 +542,8 @@ class DenseCoeffsBase<Derived, DirectAccessors> : public DenseCoeffsBase<Derived /** \brief Base class providing direct read/write coefficient access to matrices and arrays. * \ingroup Core_Module * \tparam Derived Type of the derived class - * \tparam #DirectWriteAccessors Constant indicating direct access + * + * \note #DirectWriteAccessors Constant indicating direct access * * This class defines functions to work with strides which can be used to access entries directly. This class * inherits DenseCoeffsBase<Derived, WriteAccessors> which defines functions to access entries read/write using diff --git a/Eigen/src/Core/EigenBase.h b/Eigen/src/Core/EigenBase.h index b195506a9..0c34fb656 100644 --- a/Eigen/src/Core/EigenBase.h +++ b/Eigen/src/Core/EigenBase.h @@ -32,8 +32,9 @@ template<typename Derived> struct EigenBase /** \brief The interface type of indices * \details To change this, \c \#define the preprocessor symbol \c EIGEN_DEFAULT_DENSE_INDEX_TYPE. - * \deprecated Since Eigen 3.3, its usage is deprecated. Use Eigen::Index instead. * \sa StorageIndex, \ref TopicPreprocessorDirectives. + * DEPRECATED: Since Eigen 3.3, its usage is deprecated. Use Eigen::Index instead. + * Deprecation is not marked with a doxygen comment because there are too many existing usages to add the deprecation attribute. */ typedef Eigen::Index Index; diff --git a/Eigen/src/Core/TriangularMatrix.h b/Eigen/src/Core/TriangularMatrix.h index b31972ad0..8fc7a85ab 100644 --- a/Eigen/src/Core/TriangularMatrix.h +++ b/Eigen/src/Core/TriangularMatrix.h @@ -449,13 +449,13 @@ template<typename _MatrixType, unsigned int _Mode> class TriangularViewImpl<_Mat TriangularViewType& operator=(const TriangularViewImpl& other) { return *this = other.derived().nestedExpression(); } - /** \deprecated */ template<typename OtherDerived> + /** \deprecated */ EIGEN_DEPRECATED EIGEN_DEVICE_FUNC void lazyAssign(const TriangularBase<OtherDerived>& other); - /** \deprecated */ template<typename OtherDerived> + /** \deprecated */ EIGEN_DEPRECATED EIGEN_DEVICE_FUNC void lazyAssign(const MatrixBase<OtherDerived>& other); #endif @@ -536,9 +536,9 @@ template<typename _MatrixType, unsigned int _Mode> class TriangularViewImpl<_Mat call_assignment(derived(), other.const_cast_derived(), internal::swap_assign_op<Scalar>()); } - /** \deprecated - * Shortcut for \code (*this).swap(other.triangularView<(*this)::Mode>()) \endcode */ + /** Shortcut for \code (*this).swap(other.triangularView<(*this)::Mode>()) \endcode */ template<typename OtherDerived> + /** \deprecated */ EIGEN_DEPRECATED EIGEN_DEVICE_FUNC void swap(MatrixBase<OtherDerived> const & other) { |