diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index ccd27cb6fb..10853dc692 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -132,7 +132,7 @@ if(DOXYGEN_FOUND) # set export variables string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_INPUT_LIST "${rootfile} ; ${faqfile} ; ${paths_include} ; ${paths_hal_interface} ; ${paths_doc} ; ${tutorial_path} ; ${tutorial_py_path} ; ${tutorial_js_path} ; ${paths_tutorial} ; ${tutorial_contrib_root}") - string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_IMAGE_PATH "${paths_doc} ; ${tutorial_path} ; ${tutorial_py_path} ; ${tutorial_js_path} ; ${paths_tutorial}") + string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_IMAGE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/images ; ${paths_doc} ; ${tutorial_path} ; ${tutorial_py_path} ; ${tutorial_js_path} ; ${paths_tutorial}") string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_EXCLUDE_LIST "${CMAKE_DOXYGEN_EXCLUDE_LIST}") string(REPLACE ";" " " CMAKE_DOXYGEN_ENABLED_SECTIONS "${CMAKE_DOXYGEN_ENABLED_SECTIONS}") # TODO: remove paths_doc from EXAMPLE_PATH after face module tutorials/samples moved to separate folders diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 456bd00524..2c4a3682fa 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -261,9 +261,7 @@ GENERATE_TAGFILE = @CMAKE_DOXYGEN_OUTPUT_PATH@/html/opencv.tag ALLEXTERNALS = NO EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES -PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = YES -MSCGEN_PATH = DIA_PATH = HIDE_UNDOC_RELATIONS = NO HAVE_DOT = NO diff --git a/doc/js_tutorials/js_video/js_meanshift/images/camshift_face.gif b/doc/images/camshift_face.gif similarity index 100% rename from doc/js_tutorials/js_video/js_meanshift/images/camshift_face.gif rename to doc/images/camshift_face.gif diff --git a/doc/tutorials/video/meanshift/images/camshift_result.jpg b/doc/images/camshift_result.jpg similarity index 100% rename from doc/tutorials/video/meanshift/images/camshift_result.jpg rename to doc/images/camshift_result.jpg diff --git a/doc/js_tutorials/js_video/js_meanshift/images/meanshift_basics.jpg b/doc/images/meanshift_basics.jpg similarity index 100% rename from doc/js_tutorials/js_video/js_meanshift/images/meanshift_basics.jpg rename to doc/images/meanshift_basics.jpg diff --git a/doc/js_tutorials/js_video/js_meanshift/images/meanshift_face.gif b/doc/images/meanshift_face.gif similarity index 100% rename from doc/js_tutorials/js_video/js_meanshift/images/meanshift_face.gif rename to doc/images/meanshift_face.gif diff --git a/doc/tutorials/video/meanshift/images/meanshift_result.jpg b/doc/images/meanshift_result.jpg similarity index 100% rename from doc/tutorials/video/meanshift/images/meanshift_result.jpg rename to doc/images/meanshift_result.jpg diff --git a/doc/js_tutorials/js_video/js_lucas_kanade/images/optical_flow_basic1.jpg b/doc/images/optical_flow_basic1.jpg similarity index 100% rename from doc/js_tutorials/js_video/js_lucas_kanade/images/optical_flow_basic1.jpg rename to doc/images/optical_flow_basic1.jpg diff --git a/doc/tutorials/video/optical_flow/images/opticalfb.jpg b/doc/images/opticalfb.jpg similarity index 100% rename from doc/tutorials/video/optical_flow/images/opticalfb.jpg rename to doc/images/opticalfb.jpg diff --git a/doc/tutorials/video/optical_flow/images/opticalflow_lk.jpg b/doc/images/opticalflow_lk.jpg similarity index 100% rename from doc/tutorials/video/optical_flow/images/opticalflow_lk.jpg rename to doc/images/opticalflow_lk.jpg diff --git a/doc/tutorials/introduction/desktop_java/images/lena.png b/doc/tutorials/introduction/desktop_java/images/lena.png deleted file mode 100644 index 68342fae53..0000000000 Binary files a/doc/tutorials/introduction/desktop_java/images/lena.png and /dev/null differ diff --git a/doc/tutorials/introduction/display_image/images/Display_Image_Tutorial_Result.jpg b/doc/tutorials/introduction/display_image/images/Display_Image_Tutorial_Result.jpg deleted file mode 100644 index 16400698f0..0000000000 Binary files a/doc/tutorials/introduction/display_image/images/Display_Image_Tutorial_Result.jpg and /dev/null differ diff --git a/doc/tutorials/introduction/images/Display_Image_Tutorial_Result.jpg b/doc/tutorials/introduction/images/Display_Image_Tutorial_Result.jpg index 9c646e21ae..16400698f0 100644 Binary files a/doc/tutorials/introduction/images/Display_Image_Tutorial_Result.jpg and b/doc/tutorials/introduction/images/Display_Image_Tutorial_Result.jpg differ diff --git a/doc/tutorials/introduction/images/Load_Save_Image_Result_1.jpg b/doc/tutorials/introduction/images/Load_Save_Image_Result_1.jpg index 5b8fc982ce..fcc7afa4e3 100644 Binary files a/doc/tutorials/introduction/images/Load_Save_Image_Result_1.jpg and b/doc/tutorials/introduction/images/Load_Save_Image_Result_1.jpg differ diff --git a/doc/tutorials/introduction/load_save_image/images/Load_Save_Image_Result_2.jpg b/doc/tutorials/introduction/images/Load_Save_Image_Result_2.jpg similarity index 100% rename from doc/tutorials/introduction/load_save_image/images/Load_Save_Image_Result_2.jpg rename to doc/tutorials/introduction/images/Load_Save_Image_Result_2.jpg diff --git a/doc/tutorials/introduction/clojure_dev_intro/images/lena.png b/doc/tutorials/introduction/images/lena.png similarity index 100% rename from doc/tutorials/introduction/clojure_dev_intro/images/lena.png rename to doc/tutorials/introduction/images/lena.png diff --git a/doc/tutorials/introduction/load_save_image/images/Load_Save_Image_Result_1.jpg b/doc/tutorials/introduction/load_save_image/images/Load_Save_Image_Result_1.jpg deleted file mode 100644 index fcc7afa4e3..0000000000 Binary files a/doc/tutorials/introduction/load_save_image/images/Load_Save_Image_Result_1.jpg and /dev/null differ diff --git a/doc/tutorials/ios/hello/hello.markdown b/doc/tutorials/ios/hello/hello.markdown index 5a499c3091..44f14adb12 100644 --- a/doc/tutorials/ios/hello/hello.markdown +++ b/doc/tutorials/ios/hello/hello.markdown @@ -50,7 +50,7 @@ Now we will learn how to write a simple Hello World Application in Xcode using O Output ------ -![](images/output.png) +![](images/ios_hello_output.png) Changes for XCode5+ and iOS8+ ----------------------------- diff --git a/doc/tutorials/ios/hello/images/output.png b/doc/tutorials/ios/hello/images/ios_hello_output.png similarity index 100% rename from doc/tutorials/ios/hello/images/output.png rename to doc/tutorials/ios/hello/images/ios_hello_output.png diff --git a/doc/tutorials/ml/introduction_to_pca/images/output.png b/doc/tutorials/ml/introduction_to_pca/images/pca_output.png similarity index 100% rename from doc/tutorials/ml/introduction_to_pca/images/output.png rename to doc/tutorials/ml/introduction_to_pca/images/pca_output.png diff --git a/doc/tutorials/ml/introduction_to_pca/introduction_to_pca.markdown b/doc/tutorials/ml/introduction_to_pca/introduction_to_pca.markdown index fe712a5f7f..1908e9619e 100644 --- a/doc/tutorials/ml/introduction_to_pca/introduction_to_pca.markdown +++ b/doc/tutorials/ml/introduction_to_pca/introduction_to_pca.markdown @@ -205,4 +205,4 @@ The code opens an image, finds the orientation of the detected objects of intere ![](images/pca_test1.jpg) -![](images/output.png) +![](images/pca_output.png) diff --git a/doc/tutorials/video/meanshift/images/camshift_face.gif b/doc/tutorials/video/meanshift/images/camshift_face.gif deleted file mode 100644 index d46e1c7915..0000000000 Binary files a/doc/tutorials/video/meanshift/images/camshift_face.gif and /dev/null differ diff --git a/doc/tutorials/video/meanshift/images/meanshift_basics.jpg b/doc/tutorials/video/meanshift/images/meanshift_basics.jpg deleted file mode 100644 index 73e513fb14..0000000000 Binary files a/doc/tutorials/video/meanshift/images/meanshift_basics.jpg and /dev/null differ diff --git a/doc/tutorials/video/meanshift/images/meanshift_face.gif b/doc/tutorials/video/meanshift/images/meanshift_face.gif deleted file mode 100644 index 6f9733146e..0000000000 Binary files a/doc/tutorials/video/meanshift/images/meanshift_face.gif and /dev/null differ diff --git a/doc/tutorials/video/optical_flow/images/optical_flow_basic1.jpg b/doc/tutorials/video/optical_flow/images/optical_flow_basic1.jpg deleted file mode 100644 index 718d83c10b..0000000000 Binary files a/doc/tutorials/video/optical_flow/images/optical_flow_basic1.jpg and /dev/null differ diff --git a/modules/core/include/opencv2/core.hpp b/modules/core/include/opencv2/core.hpp index f01e2adaef..c9ae4b9a81 100644 --- a/modules/core/include/opencv2/core.hpp +++ b/modules/core/include/opencv2/core.hpp @@ -73,8 +73,10 @@ @defgroup core_cluster Clustering @defgroup core_utils Utility and system functions and macros @{ + @defgroup core_logging Logging facilities @defgroup core_utils_sse SSE utilities @defgroup core_utils_neon NEON utilities + @defgroup core_utils_vsx VSX utilities @defgroup core_utils_softfloat Softfloat support @defgroup core_utils_samples Utility functions for OpenCV samples @} diff --git a/modules/core/include/opencv2/core/softfloat.hpp b/modules/core/include/opencv2/core/softfloat.hpp index 547098038d..485e15c473 100644 --- a/modules/core/include/opencv2/core/softfloat.hpp +++ b/modules/core/include/opencv2/core/softfloat.hpp @@ -507,8 +507,8 @@ Special cases: */ CV_EXPORTS softdouble cos( const softdouble& a ); -} +//! @} core_utils_softfloat -//! @} +} // cv:: #endif diff --git a/modules/core/include/opencv2/core/utils/logger.hpp b/modules/core/include/opencv2/core/utils/logger.hpp index 47094f994d..5c67495cc2 100644 --- a/modules/core/include/opencv2/core/utils/logger.hpp +++ b/modules/core/include/opencv2/core/utils/logger.hpp @@ -11,15 +11,13 @@ #include "logger.defines.hpp" -//! @addtogroup core_logging -// This section describes OpenCV logging utilities. -// -//! @{ - namespace cv { namespace utils { namespace logging { +//! @addtogroup core_logging +//! @{ + //! Supported logging levels and their semantic enum LogLevel { LOG_LEVEL_SILENT = 0, //!< for using in setLogVevel() call @@ -79,9 +77,8 @@ CV_EXPORTS void writeLogMessage(LogLevel logLevel, const char* message); #define CV_LOG_VERBOSE(tag, v, ...) for(;;) { if (cv::utils::logging::getLogLevel() < cv::utils::logging::LOG_LEVEL_VERBOSE) break; std::stringstream ss; ss << "[VERB" << v << ":" << cv::utils::getThreadID() << "] " << __VA_ARGS__; cv::utils::logging::internal::writeLogMessage(cv::utils::logging::LOG_LEVEL_VERBOSE, ss.str().c_str()); break; } #endif +//! @} }}} // namespace -//! @} - #endif // OPENCV_LOGGER_HPP diff --git a/modules/core/include/opencv2/core/utils/trace.hpp b/modules/core/include/opencv2/core/utils/trace.hpp index 858e973a83..ef5d35b4f2 100644 --- a/modules/core/include/opencv2/core/utils/trace.hpp +++ b/modules/core/include/opencv2/core/utils/trace.hpp @@ -7,15 +7,13 @@ #include -//! @addtogroup core_logging -// This section describes OpenCV tracing utilities. -// -//! @{ - namespace cv { namespace utils { namespace trace { +//! @addtogroup core_logging +//! @{ + //! Macro to trace function #define CV_TRACE_FUNCTION() @@ -247,8 +245,8 @@ CV_EXPORTS void traceArg(const TraceArg& arg, double value); //! @endcond -}}} // namespace - //! @} +}}} // namespace + #endif // OPENCV_TRACE_HPP diff --git a/modules/cudalegacy/include/opencv2/cudalegacy/NPP_staging.hpp b/modules/cudalegacy/include/opencv2/cudalegacy/NPP_staging.hpp index 6cc50d7a47..89e7f7cdea 100644 --- a/modules/cudalegacy/include/opencv2/cudalegacy/NPP_staging.hpp +++ b/modules/cudalegacy/include/opencv2/cudalegacy/NPP_staging.hpp @@ -72,7 +72,7 @@ CV_EXPORTS cudaStream_t nppStSetActiveCUDAstream(cudaStream_t cudaStream); -/*@}*/ +/** @} */ /** \defgroup nppi NPPST Image Processing @@ -787,7 +787,7 @@ NCVStatus nppiStSqrIntegral_8u64u_C1R_host(Ncv8u *h_src, Ncv32u srcStep, Ncv64u *h_dst, Ncv32u dstStep, NcvSize32u roiSize); -/*@}*/ +/** @} */ /** \defgroup npps NPPST Signal Processing @@ -899,8 +899,8 @@ NCVStatus nppsStCompact_32f_host(Ncv32f *h_src, Ncv32u srcLen, Ncv32f *h_dst, Ncv32u *dstLen, Ncv32f elemRemove); -/*@}*/ +/** @} */ -//! @} +//! @} cudalegacy #endif // _npp_staging_hpp_ diff --git a/modules/features2d/include/opencv2/features2d.hpp b/modules/features2d/include/opencv2/features2d.hpp index 4e68f2388d..867e89e5af 100644 --- a/modules/features2d/include/opencv2/features2d.hpp +++ b/modules/features2d/include/opencv2/features2d.hpp @@ -80,6 +80,10 @@ This section describes approaches based on local 2D features and used to categor - (Python) An example using the features2D framework to perform object categorization can be found at opencv_source_code/samples/python/find_obj.py + @defgroup feature2d_hal Hardware Acceleration Layer + @{ + @defgroup features2d_hal_interface Interface + @} @} */ diff --git a/modules/features2d/include/opencv2/features2d/hal/interface.h b/modules/features2d/include/opencv2/features2d/hal/interface.h index bcc6577c19..bc3b084264 100644 --- a/modules/features2d/include/opencv2/features2d/hal/interface.h +++ b/modules/features2d/include/opencv2/features2d/hal/interface.h @@ -2,7 +2,7 @@ #define OPENCV_FEATURE2D_HAL_INTERFACE_H #include "opencv2/core/cvdef.h" -//! @addtogroup featrure2d_hal_interface +//! @addtogroup features2d_hal_interface //! @{ //! @name Fast feature detector types diff --git a/modules/flann/include/opencv2/flann.hpp b/modules/flann/include/opencv2/flann.hpp index 050b5f7f58..887759e643 100644 --- a/modules/flann/include/opencv2/flann.hpp +++ b/modules/flann/include/opencv2/flann.hpp @@ -107,38 +107,38 @@ the index is built. `Distance` functor specifies the metric to be used to calculate the distance between two points. There are several `Distance` functors that are readily available: -@link cvflann::L2_Simple cv::flann::L2_Simple @endlink- Squared Euclidean distance functor. +cv::cvflann::L2_Simple - Squared Euclidean distance functor. This is the simpler, unrolled version. This is preferable for very low dimensionality data (eg 3D points) -@link cvflann::L2 cv::flann::L2 @endlink- Squared Euclidean distance functor, optimized version. +cv::flann::L2 - Squared Euclidean distance functor, optimized version. -@link cvflann::L1 cv::flann::L1 @endlink - Manhattan distance functor, optimized version. +cv::flann::L1 - Manhattan distance functor, optimized version. -@link cvflann::MinkowskiDistance cv::flann::MinkowskiDistance @endlink - The Minkowsky distance functor. +cv::flann::MinkowskiDistance - The Minkowsky distance functor. This is highly optimised with loop unrolling. The computation of squared root at the end is omitted for efficiency. -@link cvflann::MaxDistance cv::flann::MaxDistance @endlink - The max distance functor. It computes the +cv::flann::MaxDistance - The max distance functor. It computes the maximum distance between two vectors. This distance is not a valid kdtree distance, it's not dimensionwise additive. -@link cvflann::HammingLUT cv::flann::HammingLUT @endlink - %Hamming distance functor. It counts the bit +cv::flann::HammingLUT - %Hamming distance functor. It counts the bit differences between two strings using a lookup table implementation. -@link cvflann::Hamming cv::flann::Hamming @endlink - %Hamming distance functor. Population count is +cv::flann::Hamming - %Hamming distance functor. Population count is performed using library calls, if available. Lookup table implementation is used as a fallback. -@link cvflann::Hamming2 cv::flann::Hamming2 @endlink- %Hamming distance functor. Population count is +cv::flann::Hamming2 - %Hamming distance functor. Population count is implemented in 12 arithmetic operations (one of which is multiplication). -@link cvflann::HistIntersectionDistance cv::flann::HistIntersectionDistance @endlink - The histogram +cv::flann::HistIntersectionDistance - The histogram intersection distance functor. -@link cvflann::HellingerDistance cv::flann::HellingerDistance @endlink - The Hellinger distance functor. +cv::flann::HellingerDistance - The Hellinger distance functor. -@link cvflann::ChiSquareDistance cv::flann::ChiSquareDistance @endlink - The chi-square distance functor. +cv::flann::ChiSquareDistance - The chi-square distance functor. -@link cvflann::KL_Divergence cv::flann::KL_Divergence @endlink - The Kullback-Leibler divergence functor. +cv::flann::KL_Divergence - The Kullback-Leibler divergence functor. Although the provided implementations cover a vast range of cases, it is also possible to use a custom implementation. The distance functor is a class whose `operator()` computes the distance @@ -397,8 +397,6 @@ int GenericIndex::radiusSearch(const Mat& query, Mat& indices, Mat& di return nnIndex->radiusSearch(m_query,m_indices,m_dists,radius,searchParams); } -//! @endcond - /** * @deprecated Use GenericIndex class instead */ @@ -531,6 +529,7 @@ private: ::cvflann::Index< L1 >* nnIndex_L1; }; +//! @endcond /** @brief Clusters features using hierarchical k-means algorithm. @@ -567,8 +566,8 @@ int hierarchicalClustering(const Mat& features, Mat& centers, const ::cvflann::K return ::cvflann::hierarchicalClustering(m_features, m_centers, params, d); } -/** @deprecated -*/ +//! @cond IGNORED + template CV_DEPRECATED int hierarchicalClustering(const Mat& features, Mat& centers, const ::cvflann::KMeansIndexParams& params) { @@ -589,6 +588,8 @@ CV_DEPRECATED int hierarchicalClustering(const Mat& features, Mat& centers, cons } } +//! @endcond + //! @} flann } } // namespace cv::flann diff --git a/modules/flann/include/opencv2/flann/all_indices.h b/modules/flann/include/opencv2/flann/all_indices.h index ff53fd84c2..ba5a2f2dde 100644 --- a/modules/flann/include/opencv2/flann/all_indices.h +++ b/modules/flann/include/opencv2/flann/all_indices.h @@ -30,6 +30,8 @@ #ifndef OPENCV_FLANN_ALL_INDICES_H_ #define OPENCV_FLANN_ALL_INDICES_H_ +//! @cond IGNORED + #include "general.h" #include "nn_index.h" @@ -152,4 +154,6 @@ NNIndex* create_index_by_type(const Matrix #include @@ -189,4 +191,6 @@ private: } +//! @endcond + #endif //OPENCV_FLANN_ALLOCATOR_H_ diff --git a/modules/flann/include/opencv2/flann/any.h b/modules/flann/include/opencv2/flann/any.h index 5b57aa3df3..f5684e9962 100644 --- a/modules/flann/include/opencv2/flann/any.h +++ b/modules/flann/include/opencv2/flann/any.h @@ -12,6 +12,8 @@ * Adapted for FLANN by Marius Muja */ +//! @cond IGNORED + #include "defines.h" #include #include @@ -327,4 +329,6 @@ inline std::ostream& operator <<(std::ostream& out, const any& any_val) } +//! @endcond + #endif // OPENCV_FLANN_ANY_H_ diff --git a/modules/flann/include/opencv2/flann/autotuned_index.h b/modules/flann/include/opencv2/flann/autotuned_index.h index 2fbc6c9afb..eb4554f077 100644 --- a/modules/flann/include/opencv2/flann/autotuned_index.h +++ b/modules/flann/include/opencv2/flann/autotuned_index.h @@ -30,6 +30,8 @@ #ifndef OPENCV_FLANN_AUTOTUNED_INDEX_H_ #define OPENCV_FLANN_AUTOTUNED_INDEX_H_ +//! @cond IGNORED + #include #include "general.h" @@ -588,4 +590,6 @@ private: }; } +//! @endcond + #endif /* OPENCV_FLANN_AUTOTUNED_INDEX_H_ */ diff --git a/modules/flann/include/opencv2/flann/composite_index.h b/modules/flann/include/opencv2/flann/composite_index.h index 5e12a177bf..bcf0827c9f 100644 --- a/modules/flann/include/opencv2/flann/composite_index.h +++ b/modules/flann/include/opencv2/flann/composite_index.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_COMPOSITE_INDEX_H_ #define OPENCV_FLANN_COMPOSITE_INDEX_H_ +//! @cond IGNORED + #include "general.h" #include "nn_index.h" #include "kdtree_index.h" @@ -191,4 +193,6 @@ private: } +//! @endcond + #endif //OPENCV_FLANN_COMPOSITE_INDEX_H_ diff --git a/modules/flann/include/opencv2/flann/config.h b/modules/flann/include/opencv2/flann/config.h index 56832fd37f..c9342c00c3 100644 --- a/modules/flann/include/opencv2/flann/config.h +++ b/modules/flann/include/opencv2/flann/config.h @@ -30,9 +30,13 @@ #ifndef OPENCV_FLANN_CONFIG_H_ #define OPENCV_FLANN_CONFIG_H_ +//! @cond IGNORED + #ifdef FLANN_VERSION_ #undef FLANN_VERSION_ #endif #define FLANN_VERSION_ "1.6.10" +//! @endcond + #endif /* OPENCV_FLANN_CONFIG_H_ */ diff --git a/modules/flann/include/opencv2/flann/defines.h b/modules/flann/include/opencv2/flann/defines.h index 6fd53c2f78..884c6004d4 100644 --- a/modules/flann/include/opencv2/flann/defines.h +++ b/modules/flann/include/opencv2/flann/defines.h @@ -30,6 +30,8 @@ #ifndef OPENCV_FLANN_DEFINES_H_ #define OPENCV_FLANN_DEFINES_H_ +//! @cond IGNORED + #include "config.h" #ifdef FLANN_EXPORT @@ -161,4 +163,6 @@ enum } +//! @endcond + #endif /* OPENCV_FLANN_DEFINES_H_ */ diff --git a/modules/flann/include/opencv2/flann/dist.h b/modules/flann/include/opencv2/flann/dist.h index 4246a3dffc..fe19bb0392 100644 --- a/modules/flann/include/opencv2/flann/dist.h +++ b/modules/flann/include/opencv2/flann/dist.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_DIST_H_ #define OPENCV_FLANN_DIST_H_ +//! @cond IGNORED + #include #include #include @@ -901,4 +903,6 @@ typename Distance::ResultType ensureSimpleDistance( typename Distance::ResultTyp } +//! @endcond + #endif //OPENCV_FLANN_DIST_H_ diff --git a/modules/flann/include/opencv2/flann/dummy.h b/modules/flann/include/opencv2/flann/dummy.h index d6837e53c8..c176f2e4ef 100644 --- a/modules/flann/include/opencv2/flann/dummy.h +++ b/modules/flann/include/opencv2/flann/dummy.h @@ -2,6 +2,8 @@ #ifndef OPENCV_FLANN_DUMMY_H_ #define OPENCV_FLANN_DUMMY_H_ +//! @cond IGNORED + namespace cvflann { @@ -9,5 +11,6 @@ CV_DEPRECATED inline void dummyfunc() {} } +//! @endcond #endif /* OPENCV_FLANN_DUMMY_H_ */ diff --git a/modules/flann/include/opencv2/flann/dynamic_bitset.h b/modules/flann/include/opencv2/flann/dynamic_bitset.h index 923b658321..a00ce1bb7e 100644 --- a/modules/flann/include/opencv2/flann/dynamic_bitset.h +++ b/modules/flann/include/opencv2/flann/dynamic_bitset.h @@ -35,6 +35,8 @@ #ifndef OPENCV_FLANN_DYNAMIC_BITSET_H_ #define OPENCV_FLANN_DYNAMIC_BITSET_H_ +//! @cond IGNORED + #ifndef FLANN_USE_BOOST # define FLANN_USE_BOOST 0 #endif @@ -156,4 +158,6 @@ private: #endif +//! @endcond + #endif // OPENCV_FLANN_DYNAMIC_BITSET_H_ diff --git a/modules/flann/include/opencv2/flann/flann_base.hpp b/modules/flann/include/opencv2/flann/flann_base.hpp index 0ffb857cc6..83606d232f 100644 --- a/modules/flann/include/opencv2/flann/flann_base.hpp +++ b/modules/flann/include/opencv2/flann/flann_base.hpp @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_BASE_HPP_ #define OPENCV_FLANN_BASE_HPP_ +//! @cond IGNORED + #include #include #include @@ -292,4 +294,7 @@ int hierarchicalClustering(const Matrix& points, } } + +//! @endcond + #endif /* OPENCV_FLANN_BASE_HPP_ */ diff --git a/modules/flann/include/opencv2/flann/general.h b/modules/flann/include/opencv2/flann/general.h index 9d5402a6f2..ac848d6230 100644 --- a/modules/flann/include/opencv2/flann/general.h +++ b/modules/flann/include/opencv2/flann/general.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_GENERAL_H_ #define OPENCV_FLANN_GENERAL_H_ +//! @cond IGNORED + #include "opencv2/core.hpp" namespace cvflann @@ -46,5 +48,6 @@ public: } +//! @endcond #endif /* OPENCV_FLANN_GENERAL_H_ */ diff --git a/modules/flann/include/opencv2/flann/ground_truth.h b/modules/flann/include/opencv2/flann/ground_truth.h index fd8f3ae7f0..17f2a8e848 100644 --- a/modules/flann/include/opencv2/flann/ground_truth.h +++ b/modules/flann/include/opencv2/flann/ground_truth.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_GROUND_TRUTH_H_ #define OPENCV_FLANN_GROUND_TRUTH_H_ +//! @cond IGNORED + #include "dist.h" #include "matrix.h" @@ -91,4 +93,6 @@ void compute_ground_truth(const Matrix& dataset, } +//! @endcond + #endif //OPENCV_FLANN_GROUND_TRUTH_H_ diff --git a/modules/flann/include/opencv2/flann/hdf5.h b/modules/flann/include/opencv2/flann/hdf5.h index 80d23b9770..75543840d6 100644 --- a/modules/flann/include/opencv2/flann/hdf5.h +++ b/modules/flann/include/opencv2/flann/hdf5.h @@ -30,6 +30,8 @@ #ifndef OPENCV_FLANN_HDF5_H_ #define OPENCV_FLANN_HDF5_H_ +//! @cond IGNORED + #include #include "matrix.h" @@ -228,4 +230,6 @@ void load_from_file(cvflann::Matrix& dataset, const String& filename, const S #endif // HAVE_MPI } // namespace cvflann::mpi +//! @endcond + #endif /* OPENCV_FLANN_HDF5_H_ */ diff --git a/modules/flann/include/opencv2/flann/heap.h b/modules/flann/include/opencv2/flann/heap.h index 92a6ea614b..ee1c682cfe 100644 --- a/modules/flann/include/opencv2/flann/heap.h +++ b/modules/flann/include/opencv2/flann/heap.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_HEAP_H_ #define OPENCV_FLANN_HEAP_H_ +//! @cond IGNORED + #include #include @@ -162,4 +164,6 @@ public: } +//! @endcond + #endif //OPENCV_FLANN_HEAP_H_ diff --git a/modules/flann/include/opencv2/flann/hierarchical_clustering_index.h b/modules/flann/include/opencv2/flann/hierarchical_clustering_index.h index e2fce857a9..20304ede73 100644 --- a/modules/flann/include/opencv2/flann/hierarchical_clustering_index.h +++ b/modules/flann/include/opencv2/flann/hierarchical_clustering_index.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_HIERARCHICAL_CLUSTERING_INDEX_H_ #define OPENCV_FLANN_HIERARCHICAL_CLUSTERING_INDEX_H_ +//! @cond IGNORED + #include #include #include @@ -845,4 +847,6 @@ private: } +//! @endcond + #endif /* OPENCV_FLANN_HIERARCHICAL_CLUSTERING_INDEX_H_ */ diff --git a/modules/flann/include/opencv2/flann/index_testing.h b/modules/flann/include/opencv2/flann/index_testing.h index d76400409a..47b6f0b86f 100644 --- a/modules/flann/include/opencv2/flann/index_testing.h +++ b/modules/flann/include/opencv2/flann/index_testing.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_INDEX_TESTING_H_ #define OPENCV_FLANN_INDEX_TESTING_H_ +//! @cond IGNORED + #include #include #include @@ -315,4 +317,6 @@ void test_index_precisions(NNIndex& index, const Matrix #include #include @@ -623,4 +625,6 @@ private: } +//! @endcond + #endif //OPENCV_FLANN_KDTREE_INDEX_H_ diff --git a/modules/flann/include/opencv2/flann/kdtree_single_index.h b/modules/flann/include/opencv2/flann/kdtree_single_index.h index 22a28d0c1a..fa38f9f1a2 100644 --- a/modules/flann/include/opencv2/flann/kdtree_single_index.h +++ b/modules/flann/include/opencv2/flann/kdtree_single_index.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_KDTREE_SINGLE_INDEX_H_ #define OPENCV_FLANN_KDTREE_SINGLE_INDEX_H_ +//! @cond IGNORED + #include #include #include @@ -632,4 +634,6 @@ private: } +//! @endcond + #endif //OPENCV_FLANN_KDTREE_SINGLE_INDEX_H_ diff --git a/modules/flann/include/opencv2/flann/kmeans_index.h b/modules/flann/include/opencv2/flann/kmeans_index.h index 500745121f..7574e7faf8 100644 --- a/modules/flann/include/opencv2/flann/kmeans_index.h +++ b/modules/flann/include/opencv2/flann/kmeans_index.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_KMEANS_INDEX_H_ #define OPENCV_FLANN_KMEANS_INDEX_H_ +//! @cond IGNORED + #include #include #include @@ -1169,4 +1171,6 @@ private: } +//! @endcond + #endif //OPENCV_FLANN_KMEANS_INDEX_H_ diff --git a/modules/flann/include/opencv2/flann/linear_index.h b/modules/flann/include/opencv2/flann/linear_index.h index ca3f44d0cb..8a0f10fd86 100644 --- a/modules/flann/include/opencv2/flann/linear_index.h +++ b/modules/flann/include/opencv2/flann/linear_index.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_LINEAR_INDEX_H_ #define OPENCV_FLANN_LINEAR_INDEX_H_ +//! @cond IGNORED + #include "general.h" #include "nn_index.h" @@ -129,4 +131,6 @@ private: } +//! @endcond + #endif // OPENCV_FLANN_LINEAR_INDEX_H_ diff --git a/modules/flann/include/opencv2/flann/logger.h b/modules/flann/include/opencv2/flann/logger.h index 32618dbbb7..8911812a77 100644 --- a/modules/flann/include/opencv2/flann/logger.h +++ b/modules/flann/include/opencv2/flann/logger.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_LOGGER_H #define OPENCV_FLANN_LOGGER_H +//! @cond IGNORED + #include #include @@ -132,4 +134,6 @@ private: } +//! @endcond + #endif //OPENCV_FLANN_LOGGER_H diff --git a/modules/flann/include/opencv2/flann/lsh_index.h b/modules/flann/include/opencv2/flann/lsh_index.h index 42afe892ac..ee620dae3e 100644 --- a/modules/flann/include/opencv2/flann/lsh_index.h +++ b/modules/flann/include/opencv2/flann/lsh_index.h @@ -35,6 +35,8 @@ #ifndef OPENCV_FLANN_LSH_INDEX_H_ #define OPENCV_FLANN_LSH_INDEX_H_ +//! @cond IGNORED + #include #include #include @@ -389,4 +391,6 @@ private: }; } +//! @endcond + #endif //OPENCV_FLANN_LSH_INDEX_H_ diff --git a/modules/flann/include/opencv2/flann/lsh_table.h b/modules/flann/include/opencv2/flann/lsh_table.h index b07a9d5284..db8b5af946 100644 --- a/modules/flann/include/opencv2/flann/lsh_table.h +++ b/modules/flann/include/opencv2/flann/lsh_table.h @@ -35,6 +35,8 @@ #ifndef OPENCV_FLANN_LSH_TABLE_H_ #define OPENCV_FLANN_LSH_TABLE_H_ +//! @cond IGNORED + #include #include #include @@ -510,4 +512,6 @@ inline LshStats LshTable::getStats() const //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// +//! @endcond + #endif /* OPENCV_FLANN_LSH_TABLE_H_ */ diff --git a/modules/flann/include/opencv2/flann/matrix.h b/modules/flann/include/opencv2/flann/matrix.h index f6092d134e..34893b72c3 100644 --- a/modules/flann/include/opencv2/flann/matrix.h +++ b/modules/flann/include/opencv2/flann/matrix.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_DATASET_H_ #define OPENCV_FLANN_DATASET_H_ +//! @cond IGNORED + #include #include "general.h" @@ -113,4 +115,6 @@ public: } +//! @endcond + #endif //OPENCV_FLANN_DATASET_H_ diff --git a/modules/flann/include/opencv2/flann/miniflann.hpp b/modules/flann/include/opencv2/flann/miniflann.hpp index bda2ed4982..dd3c743732 100644 --- a/modules/flann/include/opencv2/flann/miniflann.hpp +++ b/modules/flann/include/opencv2/flann/miniflann.hpp @@ -43,6 +43,8 @@ #ifndef OPENCV_MINIFLANN_HPP #define OPENCV_MINIFLANN_HPP +//! @cond IGNORED + #include "opencv2/core.hpp" #include "opencv2/flann/defines.h" @@ -159,4 +161,6 @@ protected: } } // namespace cv::flann +//! @endcond + #endif diff --git a/modules/flann/include/opencv2/flann/nn_index.h b/modules/flann/include/opencv2/flann/nn_index.h index 381d4bc3cb..00fe6ec5ae 100644 --- a/modules/flann/include/opencv2/flann/nn_index.h +++ b/modules/flann/include/opencv2/flann/nn_index.h @@ -36,6 +36,8 @@ #include "result_set.h" #include "params.h" +//! @cond IGNORED + namespace cvflann { @@ -174,4 +176,6 @@ public: } +//! @endcond + #endif //OPENCV_FLANN_NNINDEX_H diff --git a/modules/flann/include/opencv2/flann/object_factory.h b/modules/flann/include/opencv2/flann/object_factory.h index 7f971c5a31..5cc45ad1b3 100644 --- a/modules/flann/include/opencv2/flann/object_factory.h +++ b/modules/flann/include/opencv2/flann/object_factory.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_OBJECT_FACTORY_H_ #define OPENCV_FLANN_OBJECT_FACTORY_H_ +//! @cond IGNORED + #include namespace cvflann @@ -88,4 +90,6 @@ private: } +//! @endcond + #endif /* OPENCV_FLANN_OBJECT_FACTORY_H_ */ diff --git a/modules/flann/include/opencv2/flann/params.h b/modules/flann/include/opencv2/flann/params.h index 95ef4cd23b..b8f7331905 100644 --- a/modules/flann/include/opencv2/flann/params.h +++ b/modules/flann/include/opencv2/flann/params.h @@ -30,6 +30,8 @@ #ifndef OPENCV_FLANN_PARAMS_H_ #define OPENCV_FLANN_PARAMS_H_ +//! @cond IGNORED + #include "any.h" #include "general.h" #include @@ -95,5 +97,6 @@ inline void print_params(const IndexParams& params) } +//! @endcond #endif /* OPENCV_FLANN_PARAMS_H_ */ diff --git a/modules/flann/include/opencv2/flann/random.h b/modules/flann/include/opencv2/flann/random.h index d6784747c0..3bb48b687b 100644 --- a/modules/flann/include/opencv2/flann/random.h +++ b/modules/flann/include/opencv2/flann/random.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_RANDOM_H #define OPENCV_FLANN_RANDOM_H +//! @cond IGNORED + #include #include #include @@ -152,4 +154,6 @@ public: } +//! @endcond + #endif //OPENCV_FLANN_RANDOM_H diff --git a/modules/flann/include/opencv2/flann/result_set.h b/modules/flann/include/opencv2/flann/result_set.h index e5b6fb24e2..735028fb45 100644 --- a/modules/flann/include/opencv2/flann/result_set.h +++ b/modules/flann/include/opencv2/flann/result_set.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_RESULTSET_H #define OPENCV_FLANN_RESULTSET_H +//! @cond IGNORED + #include #include #include @@ -540,4 +542,6 @@ private: }; } +//! @endcond + #endif //OPENCV_FLANN_RESULTSET_H diff --git a/modules/flann/include/opencv2/flann/sampling.h b/modules/flann/include/opencv2/flann/sampling.h index 396f177ae3..4e452b9bba 100644 --- a/modules/flann/include/opencv2/flann/sampling.h +++ b/modules/flann/include/opencv2/flann/sampling.h @@ -30,6 +30,8 @@ #ifndef OPENCV_FLANN_SAMPLING_H_ #define OPENCV_FLANN_SAMPLING_H_ +//! @cond IGNORED + #include "matrix.h" #include "random.h" @@ -77,5 +79,6 @@ Matrix random_sample(const Matrix& srcMatrix, size_t size) } // namespace +//! @endcond #endif /* OPENCV_FLANN_SAMPLING_H_ */ diff --git a/modules/flann/include/opencv2/flann/saving.h b/modules/flann/include/opencv2/flann/saving.h index 7e3bea564b..53359b4b7b 100644 --- a/modules/flann/include/opencv2/flann/saving.h +++ b/modules/flann/include/opencv2/flann/saving.h @@ -29,6 +29,8 @@ #ifndef OPENCV_FLANN_SAVING_H_ #define OPENCV_FLANN_SAVING_H_ +//! @cond IGNORED + #include #include @@ -184,4 +186,6 @@ void load_value(FILE* stream, std::vector& value) } +//! @endcond + #endif /* OPENCV_FLANN_SAVING_H_ */ diff --git a/modules/flann/include/opencv2/flann/simplex_downhill.h b/modules/flann/include/opencv2/flann/simplex_downhill.h index 145901ab0d..9fd84f488c 100644 --- a/modules/flann/include/opencv2/flann/simplex_downhill.h +++ b/modules/flann/include/opencv2/flann/simplex_downhill.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_SIMPLEX_DOWNHILL_H_ #define OPENCV_FLANN_SIMPLEX_DOWNHILL_H_ +//! @cond IGNORED + namespace cvflann { @@ -183,4 +185,6 @@ float optimizeSimplexDownhill(T* points, int n, F func, float* vals = NULL ) } +//! @endcond + #endif //OPENCV_FLANN_SIMPLEX_DOWNHILL_H_ diff --git a/modules/flann/include/opencv2/flann/timer.h b/modules/flann/include/opencv2/flann/timer.h index f771a34179..73795aa35b 100644 --- a/modules/flann/include/opencv2/flann/timer.h +++ b/modules/flann/include/opencv2/flann/timer.h @@ -31,6 +31,8 @@ #ifndef OPENCV_FLANN_TIMER_H #define OPENCV_FLANN_TIMER_H +//! @cond IGNORED + #include #include "opencv2/core.hpp" #include "opencv2/core/utility.hpp" @@ -91,4 +93,6 @@ public: } +//! @endcond + #endif // FLANN_TIMER_H diff --git a/modules/photo/include/opencv2/photo.hpp b/modules/photo/include/opencv2/photo.hpp index 8b0652ad90..a457295a48 100644 --- a/modules/photo/include/opencv2/photo.hpp +++ b/modules/photo/include/opencv2/photo.hpp @@ -77,6 +77,8 @@ Useful links: http://www.inf.ufrgs.br/~eslgastal/DomainTransform https://www.learnopencv.com/non-photorealistic-rendering-using-opencv-python-c/ + + @defgroup photo_c C API @} */