Assorted documentation fixes

* removed private flann documentation
* common tutorial images moved to doc/images
* grouping issues

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

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

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+
 -----------------------------

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)

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
  @}

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

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

modules/core/include/opencv2/core/utils/trace.hpp

@@ -7,15 +7,13 @@
 
 #include <opencv2/core/cvdef.h>
 
-//! @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

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_

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
+ @}
  @}
  */
 

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

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<Distance>::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 @@ class Index_
  ::cvflann::Index< L1<ElementType> >* 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<Distance>(m_features, m_centers, params, d);
 }
 
-/** @deprecated
-*/
+//! @cond IGNORED
+
 template <typename ELEM_TYPE, typename DIST_TYPE>
 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

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<Distance>* create_index_by_type(const Matrix<typename Distance::ElementT
 
 }
 
+//! @endcond
+
 #endif /* OPENCV_FLANN_ALL_INDICES_H_ */

modules/flann/include/opencv2/flann/allocator.h

@@ -31,6 +31,8 @@
 #ifndef OPENCV_FLANN_ALLOCATOR_H_
 #define OPENCV_FLANN_ALLOCATOR_H_
 
+//! @cond IGNORED
+
 #include <stdlib.h>
 #include <stdio.h>
 
@@ -189,4 +191,6 @@ class PooledAllocator
 
 }
 
+//! @endcond
+
 #endif //OPENCV_FLANN_ALLOCATOR_H_

modules/flann/include/opencv2/flann/any.h

@@ -12,6 +12,8 @@
  * Adapted for FLANN by Marius Muja
  */
 
+//! @cond IGNORED
+
 #include "defines.h"
 #include <stdexcept>
 #include <ostream>
@@ -327,4 +329,6 @@ inline std::ostream& operator <<(std::ostream& out, const any& any_val)
 
 }
 
+//! @endcond
+
 #endif // OPENCV_FLANN_ANY_H_

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 <sstream>
 
 #include "general.h"
@@ -588,4 +590,6 @@ class AutotunedIndex : public NNIndex<Distance>
 };
 }
 
+//! @endcond
+
 #endif /* OPENCV_FLANN_AUTOTUNED_INDEX_H_ */

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 @@ class CompositeIndex : public NNIndex<Distance>
 
 }
 
+//! @endcond
+
 #endif //OPENCV_FLANN_COMPOSITE_INDEX_H_

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_ */

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_ */

modules/flann/include/opencv2/flann/dist.h

@@ -31,6 +31,8 @@
 #ifndef OPENCV_FLANN_DIST_H_
 #define OPENCV_FLANN_DIST_H_
 
+//! @cond IGNORED
+
 #include <cmath>
 #include <cstdlib>
 #include <string.h>
@@ -901,4 +903,6 @@ typename Distance::ResultType ensureSimpleDistance( typename Distance::ResultTyp
 
 }
 
+//! @endcond
+
 #endif //OPENCV_FLANN_DIST_H_

modules/flann/include/opencv2/flann/dummy.h

@@ -2,12 +2,15 @@
 #ifndef OPENCV_FLANN_DUMMY_H_
 #define OPENCV_FLANN_DUMMY_H_
 
+//! @cond IGNORED
+
 namespace cvflann
 {
 
 CV_DEPRECATED inline void dummyfunc() {}
 
 }
 
+//! @endcond
 
 #endif /* OPENCV_FLANN_DUMMY_H_ */