Doxygen documentation: BiB references and fixes

doc/CMakeLists.txt

@@ -166,20 +166,27 @@ if(BUILD_DOCS AND HAVE_DOXYGEN)
   set(paths_include)
   set(paths_doc)
   set(paths_bib)
+  set(deps)
   foreach(m ${BASE_MODULES} ${EXTRA_MODULES})
     list(FIND blacklist ${m} _pos)
     if(${_pos} EQUAL -1)
+      # include folder
       set(header_dir "${OPENCV_MODULE_opencv_${m}_LOCATION}/include")
       if(EXISTS "${header_dir}")
         list(APPEND paths_include "${header_dir}")
+        list(APPEND deps ${header_dir})
       endif()
+      # doc folder
       set(docs_dir "${OPENCV_MODULE_opencv_${m}_LOCATION}/doc")
       if(EXISTS "${docs_dir}")
         list(APPEND paths_doc "${docs_dir}")
-        file(GLOB bib_file "${docs_dir}" "*.bib")
+        list(APPEND deps ${docs_dir})
-        if(EXISTS "${bib_file}")
-          list(APPEND paths_bib "${bib_file}")
       endif()
+      # BiBTeX file
+      set(bib_file "${docs_dir}/${m}.bib")
+      if(EXISTS "${bib_file}")
+        set(paths_bib "${paths_bib} ${bib_file}")
+        list(APPEND deps ${bib_file})
       endif()
     endif()
   endforeach()
@@ -204,10 +211,11 @@ if(BUILD_DOCS AND HAVE_DOXYGEN)
   configure_file(Doxyfile.in ${doxyfile} @ONLY)
   configure_file(root.markdown.in ${rootfile} @ONLY)
   configure_file(mymath.sty "${CMAKE_DOXYGEN_OUTPUT_PATH}/html/mymath.sty" @ONLY)
+  configure_file(mymath.sty "${CMAKE_DOXYGEN_OUTPUT_PATH}/latex/mymath.sty" @ONLY)
 
   add_custom_target(doxygen
     COMMAND ${DOXYGEN_BUILD} ${doxyfile}
-    DEPENDS ${doxyfile} ${all_headers} ${all_images})
+DEPENDS ${doxyfile} ${rootfile} ${bibfile} ${deps})
 endif()
 
 if(HAVE_DOC_GENERATOR)

doc/disabled_doc_warnings.txt

@@ -0,0 +1,2 @@
+# doxygen citelist build workaround
+citelist : .*Unexpected new line character.*

modules/calib3d/include/opencv2/calib3d.hpp

@@ -1605,6 +1605,7 @@ public:
                                           int mode = StereoSGBM::MODE_SGBM);
 };
 
+//! @} calib3d
 
 /** @brief The methods in this namespace use a so-called fisheye camera model.
   @ingroup calib3d_fisheye
@@ -1851,8 +1852,6 @@ namespace fisheye
 //! @} calib3d_fisheye
 }
 
-//! @} calib3d
-
 } // cv
 
 #endif

modules/core/include/opencv2/core.hpp

@@ -75,6 +75,9 @@
     @defgroup core_opengl OpenGL interoperability
     @defgroup core_ipp Intel IPP Asynchronous C/C++ Converters
     @defgroup core_optim Optimization Algorithms
+    @defgroup core_directx DirectX interoperability
+    @defgroup core_eigen Eigen support
+    @defgroup core_opencl OpenCL support
 @}
  */
 

modules/cudabgsegm/include/opencv2/cudabgsegm.hpp

@@ -119,7 +119,7 @@ CV_EXPORTS Ptr<cuda::BackgroundSubtractorMOG>
 
 The class discriminates between foreground and background pixels by building and maintaining a model
 of the background. Any pixel which does not fit this model is then deemed to be foreground. The
-class implements algorithm described in @cite MOG2004.
+class implements algorithm described in @cite Zivkovic2004 .
 
 @sa BackgroundSubtractorMOG2
  */
@@ -154,7 +154,7 @@ CV_EXPORTS Ptr<cuda::BackgroundSubtractorMOG2>
 
 The class discriminates between foreground and background pixels by building and maintaining a model
 of the background. Any pixel which does not fit this model is then deemed to be foreground. The
-class implements algorithm described in @cite GMG2012.
+class implements algorithm described in @cite Gold2012 .
  */
 class CV_EXPORTS BackgroundSubtractorGMG : public cv::BackgroundSubtractor
 {

modules/cudalegacy/include/opencv2/cudalegacy/NCV.hpp

@@ -205,6 +205,7 @@ struct NcvPoint2D32u
     __host__ __device__ NcvPoint2D32u(Ncv32u x_, Ncv32u y_) : x(x_), y(y_) {}
 };
 
+//! @cond IGNORED
 
 NCV_CT_ASSERT(sizeof(NcvBool) <= 4);
 NCV_CT_ASSERT(sizeof(Ncv64s) == 8);
@@ -223,6 +224,7 @@ NCV_CT_ASSERT(sizeof(NcvRect32u) == 4 * sizeof(Ncv32u));
 NCV_CT_ASSERT(sizeof(NcvSize32u) == 2 * sizeof(Ncv32u));
 NCV_CT_ASSERT(sizeof(NcvPoint2D32u) == 2 * sizeof(Ncv32u));
 
+//! @endcond
 
 //==============================================================================
 //

modules/ml/include/opencv2/ml.hpp

@@ -425,8 +425,8 @@ Regression is a binary classification algorithm which is closely related to Supp
 like digit recognition (i.e. recognizing digitis like 0,1 2, 3,... from the given images). This
 version of Logistic Regression supports both binary and multi-class classifications (for multi-class
 it creates a multiple 2-class classifiers). In order to train the logistic regression classifier,
-Batch Gradient Descent and Mini-Batch Gradient Descent algorithms are used (see @cite BatchDesWiki).
+Batch Gradient Descent and Mini-Batch Gradient Descent algorithms are used (see <http://en.wikipedia.org/wiki/Gradient_descent_optimization>).
-Logistic Regression is a discriminative classifier (see @cite LogRegTomMitch for more details).
+Logistic Regression is a discriminative classifier (see <http://www.cs.cmu.edu/~tom/NewChapters.html> for more details).
 Logistic Regression is implemented as a C++ class in LogisticRegression.
 
 In Logistic Regression, we try to optimize the training paramater \f$\theta\f$ such that the hypothesis

modules/photo/include/opencv2/photo.hpp

@@ -220,12 +220,12 @@ as the variational problem, primal-dual algorithm then can be used to perform de
 exactly what is implemented.
 
 It should be noted, that this implementation was taken from the July 2013 blog entry
-@cite Mordvintsev, which also contained (slightly more general) ready-to-use source code on Python.
+@cite MA13 , which also contained (slightly more general) ready-to-use source code on Python.
 Subsequently, that code was rewritten on C++ with the usage of openCV by Vadim Pisarevsky at the end
 of July 2013 and finally it was slightly adapted by later authors.
 
 Although the thorough discussion and justification of the algorithm involved may be found in
-@cite ChambolleEtAl, it might make sense to skim over it here, following @cite Mordvintsev. To begin
+@cite ChambolleEtAl, it might make sense to skim over it here, following @cite MA13 . To begin
 with, we consider the 1-byte gray-level images as the functions from the rectangular domain of
 pixels (it may be seen as set
 \f$\left\{(x,y)\in\mathbb{N}\times\mathbb{N}\mid 1\leq x\leq n,\;1\leq y\leq m\right\}\f$ for some

modules/videoio/include/opencv2/videoio/cap_ios.h

@@ -172,4 +172,3 @@
 @end
 
 //! @} videoio_ios
-

modules/videostab/include/opencv2/videostab.hpp

@@ -68,7 +68,7 @@ Both the functions and the classes are available.
 
          @defgroup videostab_marching Fast Marching Method
 
-The Fast Marching Method @cite T04 is used in of the video stabilization routines to do motion and
+The Fast Marching Method @cite Telea04 is used in of the video stabilization routines to do motion and
 color inpainting. The method is implemented is a flexible way and it's made public for other users.
 
      @}

modules/videostab/include/opencv2/videostab/optical_flow.hpp

@@ -55,7 +55,7 @@ namespace cv
 namespace videostab
 {
 
-//! @addtogroup vieostab
+//! @addtogroup videostab
 //! @{
 
 class CV_EXPORTS ISparseOptFlowEstimator

modules/videostab/include/opencv2/videostab/outlier_rejection.hpp

@@ -52,7 +52,7 @@ namespace cv
 namespace videostab
 {
 
-//! @addtogroup vieostab
+//! @addtogroup videostab
 //! @{
 
 class CV_EXPORTS IOutlierRejector

modules/videostab/include/opencv2/videostab/ring_buffer.hpp

@@ -51,7 +51,7 @@ namespace cv
 namespace videostab
 {
 
-//! @addtogroup vieostab
+//! @addtogroup videostab
 //! @{
 
 template <typename T> inline T& at(int idx, std::vector<T> &items)

modules/videostab/include/opencv2/videostab/stabilizer.hpp

@@ -60,7 +60,7 @@ namespace cv
 namespace videostab
 {
 
-//! @addtogroup vieostab
+//! @addtogroup videostab
 //! @{
 
 class CV_EXPORTS StabilizerBase

modules/videostab/include/opencv2/videostab/wobble_suppression.hpp

@@ -54,7 +54,7 @@ namespace cv
 namespace videostab
 {
 
-//! @addtogroup vieostab
+//! @addtogroup videostab
 //! @{
 
 class CV_EXPORTS WobbleSuppressorBase