From 781fbde44989dfbff69e532d5be2b9d2e35b2f10 Mon Sep 17 00:00:00 2001 From: Rasmus Date: Wed, 10 Jun 2020 09:53:18 +0200 Subject: [PATCH] Merge pull request #17368 from themightyoarfish:cv2eigen-doc * Add documentation about usage of cv2eigen functions in eigen.hpp * Fixed Doxygen syntax. Co-authored-by: Alexander Smorkalov --- modules/core/include/opencv2/core/eigen.hpp | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/modules/core/include/opencv2/core/eigen.hpp b/modules/core/include/opencv2/core/eigen.hpp index 8afc06caa7..3d7ba8fa14 100644 --- a/modules/core/include/opencv2/core/eigen.hpp +++ b/modules/core/include/opencv2/core/eigen.hpp @@ -66,10 +66,18 @@ namespace cv { -//! @addtogroup core_eigen +/** @addtogroup core_eigen +These functions are provided for OpenCV-Eigen interoperability. They convert `Mat` +objects to corresponding `Eigen::Matrix` objects and vice-versa. Consult the [Eigen +documentation](https://eigen.tuxfamily.org/dox/group__TutorialMatrixClass.html) for +information about the `Matrix` template type. + +@note Using these functions requires the `Eigen/Dense` or similar header to be +included before this header. +*/ //! @{ -#ifdef OPENCV_EIGEN_TENSOR_SUPPORT +#if defined(OPENCV_EIGEN_TENSOR_SUPPORT) || defined(CV_DOXYGEN) /** @brief Converts an Eigen::Tensor to a cv::Mat. The method converts an Eigen::Tensor with shape (H x W x C) to a cv::Mat where: