From 1d82aecf4588f5237c3c40041ca084f20b60a258 Mon Sep 17 00:00:00 2001 From: Vladislav Vinogradov Date: Thu, 18 Dec 2014 17:56:31 +0300 Subject: [PATCH] minor reorganization for CUDA doxygen groups: move main CUDA group to modules/core/cuda.hpp --- modules/core/include/opencv2/core/cuda.hpp | 19 +++++++++++++++---- .../include/opencv2/core/cuda_stream_accessor.hpp | 14 ++++++-------- modules/cuda/include/opencv2/cuda.hpp | 6 +----- 3 files changed, 22 insertions(+), 17 deletions(-) diff --git a/modules/core/include/opencv2/core/cuda.hpp b/modules/core/include/opencv2/core/cuda.hpp index 15d526e..ef554ec 100644 --- a/modules/core/include/opencv2/core/cuda.hpp +++ b/modules/core/include/opencv2/core/cuda.hpp @@ -51,9 +51,20 @@ #include "opencv2/core.hpp" #include "opencv2/core/cuda_types.hpp" +/** + @defgroup cuda CUDA-accelerated Computer Vision + @{ + @defgroup cudacore Core part + @{ + @defgroup cudacore_init Initalization and Information + @defgroup cudacore_struct Data Structures + @} + @} + */ + namespace cv { namespace cuda { -//! @addtogroup cuda_struct +//! @addtogroup cudacore_struct //! @{ //////////////////////////////// GpuMat /////////////////////////////// @@ -514,11 +525,11 @@ private: friend struct EventAccessor; }; -//! @} cuda_struct +//! @} cudacore_struct //////////////////////////////// Initialization & Info //////////////////////// -//! @addtogroup cuda_init +//! @addtogroup cudacore_init //! @{ /** @brief Returns the number of installed CUDA-enabled devices. @@ -813,7 +824,7 @@ private: CV_EXPORTS void printCudaDeviceInfo(int device); CV_EXPORTS void printShortCudaDeviceInfo(int device); -//! @} cuda_init +//! @} cudacore_init }} // namespace cv { namespace cuda { diff --git a/modules/core/include/opencv2/core/cuda_stream_accessor.hpp b/modules/core/include/opencv2/core/cuda_stream_accessor.hpp index 66aaf56..dd6589b 100644 --- a/modules/core/include/opencv2/core/cuda_stream_accessor.hpp +++ b/modules/core/include/opencv2/core/cuda_stream_accessor.hpp @@ -47,10 +47,9 @@ # error cuda_stream_accessor.hpp header must be compiled as C++ #endif -// This is only header file that depends on Cuda. All other headers are independent. -// So if you use OpenCV binaries you do noot need to install Cuda Toolkit. -// But of you wanna use CUDA by yourself, may get cuda stream instance using the class below. -// In this case you have to install Cuda Toolkit. +/** @file cuda_stream_accessor.hpp + * This is only header file that depends on CUDA Runtime API. All other headers are independent. + */ #include #include "opencv2/core/cvdef.h" @@ -60,22 +59,21 @@ namespace cv namespace cuda { -//! @addtogroup cuda_struct +//! @addtogroup cudacore_struct //! @{ class Stream; class Event; /** @brief Class that enables getting cudaStream_t from cuda::Stream - - because it is the only public header that depends on the CUDA Runtime API. Including it - brings a dependency to your code. */ struct StreamAccessor { CV_EXPORTS static cudaStream_t getStream(const Stream& stream); }; + /** @brief Class that enables getting cudaEvent_t from cuda::Event + */ struct EventAccessor { CV_EXPORTS static cudaEvent_t getEvent(const Event& event); diff --git a/modules/cuda/include/opencv2/cuda.hpp b/modules/cuda/include/opencv2/cuda.hpp index ac51b87..93bb511 100644 --- a/modules/cuda/include/opencv2/cuda.hpp +++ b/modules/cuda/include/opencv2/cuda.hpp @@ -50,15 +50,11 @@ #include "opencv2/core/cuda.hpp" /** -@defgroup cuda CUDA-accelerated Computer Vision - @ref cuda_intro "Introduction page" + @addtogroup cuda @{ - @defgroup cuda_init Initalization and Information - @defgroup cuda_struct Data Structures @defgroup cuda_calib3d Camera Calibration and 3D Reconstruction @defgroup cuda_objdetect Object Detection @} - */ namespace cv { namespace cuda { -- 2.7.4