diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 42e8650ad4..b4c57080e3 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -196,8 +196,9 @@ if(BUILD_DOCS AND HAVE_DOXYGEN) set(doxyfile "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile") set(rootfile "${CMAKE_CURRENT_BINARY_DIR}/root.markdown") set(bibfile "${CMAKE_CURRENT_SOURCE_DIR}/opencv.bib") - string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_INPUT_LIST "${rootfile} ; ${paths_include} ; ${paths_doc}") - string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_IMAGE_PATH "${paths_doc}") + set(tutorial_path "${CMAKE_CURRENT_SOURCE_DIR}/tutorials") + string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_INPUT_LIST "${rootfile} ; ${paths_include} ; ${paths_doc} ; ${tutorial_path}") + string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_IMAGE_PATH "${paths_doc} ; ${tutorial_path}") string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_EXAMPLE_PATH "${CMAKE_SOURCE_DIR}/samples/cpp ; ${paths_doc}") set(CMAKE_DOXYGEN_LAYOUT "${CMAKE_CURRENT_SOURCE_DIR}/DoxygenLayout.xml") set(CMAKE_DOXYGEN_OUTPUT_PATH "doxygen") @@ -214,8 +215,12 @@ if(BUILD_DOCS AND HAVE_DOXYGEN) configure_file(mymath.sty "${CMAKE_DOXYGEN_OUTPUT_PATH}/latex/mymath.sty" @ONLY) add_custom_target(doxygen + COMMAND "${CMAKE_COMMAND}" -E copy_directory "${CMAKE_SOURCE_DIR}/samples" "${CMAKE_DOXYGEN_OUTPUT_PATH}/html/samples" + COMMAND "${CMAKE_COMMAND}" -E copy "${CMAKE_CURRENT_SOURCE_DIR}/pattern.png" "${CMAKE_DOXYGEN_OUTPUT_PATH}/html" + COMMAND "${CMAKE_COMMAND}" -E copy "${CMAKE_CURRENT_SOURCE_DIR}/acircles_pattern.png" "${CMAKE_DOXYGEN_OUTPUT_PATH}/html" COMMAND ${DOXYGEN_BUILD} ${doxyfile} -DEPENDS ${doxyfile} ${rootfile} ${bibfile} ${deps}) + DEPENDS ${doxyfile} ${rootfile} ${bibfile} ${deps} + ) endif() if(HAVE_DOC_GENERATOR) diff --git a/doc/mymath.js b/doc/mymath.js index d9af0350fe..df9f551a68 100644 --- a/doc/mymath.js +++ b/doc/mymath.js @@ -9,7 +9,8 @@ MathJax.Hub.Config( vecthree: ["\\begin{bmatrix} #1\\\\ #2\\\\ #3 \\end{bmatrix}", 3], vecthreethree: ["\\begin{bmatrix} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{bmatrix}", 9], hdotsfor: ["\\dots", 1], - mathbbm: ["\\mathbb{#1}", 1] + mathbbm: ["\\mathbb{#1}", 1], + bordermatrix: ["\\matrix{#1}", 1] } } } diff --git a/doc/tutorials/calib3d/real_time_pose/real_time_pose.rst b/doc/tutorials/calib3d/real_time_pose/real_time_pose.rst index 514888382d..9410418792 100644 --- a/doc/tutorials/calib3d/real_time_pose/real_time_pose.rst +++ b/doc/tutorials/calib3d/real_time_pose/real_time_pose.rst @@ -126,7 +126,7 @@ Here is explained in detail the code for the real time application: .. code-block:: cpp - /** Load a YAML file using OpenCV **/ + /* Load a YAML file using OpenCV */ void Model::load(const std::string path) { cv::Mat points3d_mat; @@ -152,7 +152,7 @@ Here is explained in detail the code for the real time application: .. code-block:: cpp - /** Load a CSV with *.ply format **/ + /* Load a CSV with *.ply format */ void Mesh::load(const std::string path) { @@ -535,7 +535,7 @@ Here is explained in detail the code for the real time application: cv::setIdentity(KF.errorCovPost, cv::Scalar::all(1)); // error covariance - /** DYNAMIC MODEL **/ + /* DYNAMIC MODEL */ // [1 0 0 dt 0 0 dt2 0 0 0 0 0 0 0 0 0 0 0] // [0 1 0 0 dt 0 0 dt2 0 0 0 0 0 0 0 0 0 0] @@ -579,7 +579,7 @@ Here is explained in detail the code for the real time application: KF.transitionMatrix.at(11,17) = 0.5*pow(dt,2); - /** MEASUREMENT MODEL **/ + /* MEASUREMENT MODEL */ // [1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0] // [0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0] @@ -744,7 +744,6 @@ You can watch the real time pose estimation on the `YouTube here -

diff --git a/doc/tutorials/core/basic_geometric_drawing/basic_geometric_drawing.rst b/doc/tutorials/core/basic_geometric_drawing/basic_geometric_drawing.rst index b4b4fcd299..7d40e016bb 100644 --- a/doc/tutorials/core/basic_geometric_drawing/basic_geometric_drawing.rst +++ b/doc/tutorials/core/basic_geometric_drawing/basic_geometric_drawing.rst @@ -204,7 +204,7 @@ Explanation { int lineType = 8; - /** Create some points */ + /* Create some points */ Point rook_points[1][20]; rook_points[0][0] = Point( w/4.0, 7*w/8.0 ); rook_points[0][1] = Point( 3*w/4.0, 7*w/8.0 ); diff --git a/doc/tutorials/core/basic_linear_transform/basic_linear_transform.rst b/doc/tutorials/core/basic_linear_transform/basic_linear_transform.rst index 5a5597a754..f9870669c1 100644 --- a/doc/tutorials/core/basic_linear_transform/basic_linear_transform.rst +++ b/doc/tutorials/core/basic_linear_transform/basic_linear_transform.rst @@ -77,8 +77,8 @@ Code using namespace cv; - double alpha; /**< Simple contrast control */ - int beta; /**< Simple brightness control */ + double alpha; /*< Simple contrast control */ + int beta; /*< Simple brightness control */ int main( int argc, char** argv ) { diff --git a/doc/tutorials/core/mat-mask-operations/mat-mask-operations.rst b/doc/tutorials/core/mat-mask-operations/mat-mask-operations.rst index f28920e77e..dd16454f2c 100644 --- a/doc/tutorials/core/mat-mask-operations/mat-mask-operations.rst +++ b/doc/tutorials/core/mat-mask-operations/mat-mask-operations.rst @@ -133,5 +133,5 @@ Check out an instance of running the program on our `YouTube channel - + diff --git a/doc/tutorials/features2d/akaze_matching/akaze_matching.rst b/doc/tutorials/features2d/akaze_matching/akaze_matching.rst index d1b51858dd..729f1f1f5e 100644 --- a/doc/tutorials/features2d/akaze_matching/akaze_matching.rst +++ b/doc/tutorials/features2d/akaze_matching/akaze_matching.rst @@ -151,7 +151,7 @@ Found matches A-KAZE Matching Results -------------------------- - ::code-block:: none +.. code-block:: none Keypoints 1: 2943 Keypoints 2: 3511 Matches: 447 diff --git a/doc/tutorials/features2d/feature_description/feature_description.rst b/doc/tutorials/features2d/feature_description/feature_description.rst index 1937f5476a..6752dd4a9e 100644 --- a/doc/tutorials/features2d/feature_description/feature_description.rst +++ b/doc/tutorials/features2d/feature_description/feature_description.rst @@ -39,7 +39,7 @@ This tutorial code's is shown lines below. void readme(); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { if( argc != 3 ) @@ -80,7 +80,7 @@ This tutorial code's is shown lines below. return 0; } - /** @function readme */ + /* @function readme */ void readme() { std::cout << " Usage: ./SURF_descriptor " << std::endl; } diff --git a/doc/tutorials/features2d/feature_detection/feature_detection.rst b/doc/tutorials/features2d/feature_detection/feature_detection.rst index 7d5e2600ed..24684bfe3c 100644 --- a/doc/tutorials/features2d/feature_detection/feature_detection.rst +++ b/doc/tutorials/features2d/feature_detection/feature_detection.rst @@ -38,7 +38,7 @@ This tutorial code's is shown lines below. void readme(); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { if( argc != 3 ) @@ -75,7 +75,7 @@ This tutorial code's is shown lines below. return 0; } - /** @function readme */ + /* @function readme */ void readme() { std::cout << " Usage: ./SURF_detector " << std::endl; } diff --git a/doc/tutorials/features2d/feature_flann_matcher/feature_flann_matcher.rst b/doc/tutorials/features2d/feature_flann_matcher/feature_flann_matcher.rst index 6be334b9d7..ff16f80af9 100644 --- a/doc/tutorials/features2d/feature_flann_matcher/feature_flann_matcher.rst +++ b/doc/tutorials/features2d/feature_flann_matcher/feature_flann_matcher.rst @@ -23,7 +23,7 @@ This tutorial code's is shown lines below. .. code-block:: cpp - /** + /* * @file SURF_FlannMatcher * @brief SURF detector + descriptor + FLANN Matcher * @author A. Huaman @@ -45,7 +45,7 @@ This tutorial code's is shown lines below. void readme(); - /** + /* * @function main * @brief Main function */ @@ -123,7 +123,7 @@ This tutorial code's is shown lines below. return 0; } - /** + /* * @function readme */ void readme() diff --git a/doc/tutorials/features2d/feature_homography/feature_homography.rst b/doc/tutorials/features2d/feature_homography/feature_homography.rst index 47e984baa3..f6acb70e4b 100644 --- a/doc/tutorials/features2d/feature_homography/feature_homography.rst +++ b/doc/tutorials/features2d/feature_homography/feature_homography.rst @@ -37,7 +37,7 @@ This tutorial code's is shown lines below. void readme(); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { if( argc != 3 ) @@ -131,7 +131,7 @@ This tutorial code's is shown lines below. return 0; } - /** @function readme */ + /* @function readme */ void readme() { std::cout << " Usage: ./SURF_descriptor " << std::endl; } diff --git a/doc/tutorials/features2d/trackingmotion/corner_subpixeles/corner_subpixeles.rst b/doc/tutorials/features2d/trackingmotion/corner_subpixeles/corner_subpixeles.rst index 38302424b6..4f816ccbb8 100644 --- a/doc/tutorials/features2d/trackingmotion/corner_subpixeles/corner_subpixeles.rst +++ b/doc/tutorials/features2d/trackingmotion/corner_subpixeles/corner_subpixeles.rst @@ -44,7 +44,7 @@ This tutorial code's is shown lines below. You can also download it from `here < /// Function header void goodFeaturesToTrack_Demo( int, void* ); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Load source image and convert it to gray @@ -65,7 +65,7 @@ This tutorial code's is shown lines below. You can also download it from `here < return(0); } - /** + /* * @function goodFeaturesToTrack_Demo.cpp * @brief Apply Shi-Tomasi corner detector */ diff --git a/doc/tutorials/features2d/trackingmotion/good_features_to_track/good_features_to_track.rst b/doc/tutorials/features2d/trackingmotion/good_features_to_track/good_features_to_track.rst index 05bc66d263..656f5a0a6a 100644 --- a/doc/tutorials/features2d/trackingmotion/good_features_to_track/good_features_to_track.rst +++ b/doc/tutorials/features2d/trackingmotion/good_features_to_track/good_features_to_track.rst @@ -43,7 +43,7 @@ This tutorial code's is shown lines below. You can also download it from `here < /// Function header void goodFeaturesToTrack_Demo( int, void* ); - /** + /* * @function main */ int main( int argc, char** argv ) @@ -66,7 +66,7 @@ This tutorial code's is shown lines below. You can also download it from `here < return(0); } - /** + /* * @function goodFeaturesToTrack_Demo.cpp * @brief Apply Shi-Tomasi corner detector */ diff --git a/doc/tutorials/features2d/trackingmotion/harris_detector/harris_detector.rst b/doc/tutorials/features2d/trackingmotion/harris_detector/harris_detector.rst index 8cdeb2aa2c..8ac3ef8e34 100644 --- a/doc/tutorials/features2d/trackingmotion/harris_detector/harris_detector.rst +++ b/doc/tutorials/features2d/trackingmotion/harris_detector/harris_detector.rst @@ -175,7 +175,7 @@ This tutorial code's is shown lines below. You can also download it from `here < /// Function header void cornerHarris_demo( int, void* ); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Load source image and convert it to gray @@ -193,7 +193,7 @@ This tutorial code's is shown lines below. You can also download it from `here < return(0); } - /** @function cornerHarris_demo */ + /* @function cornerHarris_demo */ void cornerHarris_demo( int, void* ) { diff --git a/doc/tutorials/highgui/trackbar/trackbar.rst b/doc/tutorials/highgui/trackbar/trackbar.rst index 5749123c10..fb922849ee 100644 --- a/doc/tutorials/highgui/trackbar/trackbar.rst +++ b/doc/tutorials/highgui/trackbar/trackbar.rst @@ -42,7 +42,7 @@ Let's modify the program made in the tutorial :ref:`Adding_Images`. We will let Mat src2; Mat dst; - /** + /* * @function on_trackbar * @brief Callback for trackbar */ diff --git a/doc/tutorials/imgproc/erosion_dilatation/erosion_dilatation.rst b/doc/tutorials/imgproc/erosion_dilatation/erosion_dilatation.rst index bda9b624a8..793beeced8 100644 --- a/doc/tutorials/imgproc/erosion_dilatation/erosion_dilatation.rst +++ b/doc/tutorials/imgproc/erosion_dilatation/erosion_dilatation.rst @@ -92,11 +92,11 @@ This tutorial code's is shown lines below. You can also download it from `here < int const max_elem = 2; int const max_kernel_size = 21; - /** Function Headers */ + /* Function Headers */ void Erosion( int, void* ); void Dilation( int, void* ); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Load an image @@ -136,7 +136,7 @@ This tutorial code's is shown lines below. You can also download it from `here < return 0; } - /** @function Erosion */ + /* @function Erosion */ void Erosion( int, void* ) { int erosion_type; @@ -153,7 +153,7 @@ This tutorial code's is shown lines below. You can also download it from `here < imshow( "Erosion Demo", erosion_dst ); } - /** @function Dilation */ + /* @function Dilation */ void Dilation( int, void* ) { int dilation_type; @@ -192,7 +192,7 @@ Explanation .. code-block:: cpp - /** @function Erosion */ + /* @function Erosion */ void Erosion( int, void* ) { int erosion_type; @@ -242,7 +242,7 @@ The code is below. As you can see, it is completely similar to the snippet of co .. code-block:: cpp - /** @function Dilation */ + /* @function Dilation */ void Dilation( int, void* ) { int dilation_type; diff --git a/doc/tutorials/imgproc/gausian_median_blur_bilateral_filter/gausian_median_blur_bilateral_filter.rst b/doc/tutorials/imgproc/gausian_median_blur_bilateral_filter/gausian_median_blur_bilateral_filter.rst index e708f08aec..e82a950d20 100644 --- a/doc/tutorials/imgproc/gausian_median_blur_bilateral_filter/gausian_median_blur_bilateral_filter.rst +++ b/doc/tutorials/imgproc/gausian_median_blur_bilateral_filter/gausian_median_blur_bilateral_filter.rst @@ -140,7 +140,7 @@ Code int display_caption( char* caption ); int display_dst( int delay ); - /** + /* * function main */ int main( int argc, char** argv ) diff --git a/doc/tutorials/imgproc/histograms/back_projection/back_projection.rst b/doc/tutorials/imgproc/histograms/back_projection/back_projection.rst index 5c3a78f6f0..7138980f57 100644 --- a/doc/tutorials/imgproc/histograms/back_projection/back_projection.rst +++ b/doc/tutorials/imgproc/histograms/back_projection/back_projection.rst @@ -122,7 +122,7 @@ Code /// Function Headers void Hist_and_Backproj(int, void* ); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Read the image @@ -150,7 +150,7 @@ Code } - /** + /* * @function Hist_and_Backproj * @brief Callback to Trackbar */ diff --git a/doc/tutorials/imgproc/histograms/histogram_calculation/histogram_calculation.rst b/doc/tutorials/imgproc/histograms/histogram_calculation/histogram_calculation.rst index 558c4e76e1..acc0e8cc2c 100644 --- a/doc/tutorials/imgproc/histograms/histogram_calculation/histogram_calculation.rst +++ b/doc/tutorials/imgproc/histograms/histogram_calculation/histogram_calculation.rst @@ -96,7 +96,7 @@ Code using namespace std; using namespace cv; - /** + /* * @function main */ int main( int argc, char** argv ) diff --git a/doc/tutorials/imgproc/histograms/histogram_equalization/histogram_equalization.rst b/doc/tutorials/imgproc/histograms/histogram_equalization/histogram_equalization.rst index 884c82a2f8..076809304a 100644 --- a/doc/tutorials/imgproc/histograms/histogram_equalization/histogram_equalization.rst +++ b/doc/tutorials/imgproc/histograms/histogram_equalization/histogram_equalization.rst @@ -97,7 +97,7 @@ Code using namespace cv; using namespace std; - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { Mat src, dst; diff --git a/doc/tutorials/imgproc/histograms/template_matching/template_matching.rst b/doc/tutorials/imgproc/histograms/template_matching/template_matching.rst index 9997bb60d5..fdd5698f6e 100644 --- a/doc/tutorials/imgproc/histograms/template_matching/template_matching.rst +++ b/doc/tutorials/imgproc/histograms/template_matching/template_matching.rst @@ -150,7 +150,7 @@ Code /// Function Headers void MatchingMethod( int, void* ); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Load image and template @@ -171,7 +171,7 @@ Code return 0; } - /** + /* * @function MatchingMethod * @brief Trackbar callback */ diff --git a/doc/tutorials/imgproc/imgtrans/canny_detector/canny_detector.rst b/doc/tutorials/imgproc/imgtrans/canny_detector/canny_detector.rst index ba0f7cd686..11f9b3d8c6 100644 --- a/doc/tutorials/imgproc/imgtrans/canny_detector/canny_detector.rst +++ b/doc/tutorials/imgproc/imgtrans/canny_detector/canny_detector.rst @@ -109,7 +109,7 @@ Code int kernel_size = 3; char* window_name = "Edge Map"; - /** + /* * @function CannyThreshold * @brief Trackbar callback - Canny thresholds input with a ratio 1:3 */ @@ -129,7 +129,7 @@ Code } - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Load an image diff --git a/doc/tutorials/imgproc/imgtrans/copyMakeBorder/copyMakeBorder.rst b/doc/tutorials/imgproc/imgtrans/copyMakeBorder/copyMakeBorder.rst index 6546323b0e..6239d787e8 100644 --- a/doc/tutorials/imgproc/imgtrans/copyMakeBorder/copyMakeBorder.rst +++ b/doc/tutorials/imgproc/imgtrans/copyMakeBorder/copyMakeBorder.rst @@ -67,7 +67,7 @@ Code char* window_name = "copyMakeBorder Demo"; RNG rng(12345); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { diff --git a/doc/tutorials/imgproc/imgtrans/filter_2d/filter_2d.rst b/doc/tutorials/imgproc/imgtrans/filter_2d/filter_2d.rst index 1b6074f8d4..0548c5b501 100644 --- a/doc/tutorials/imgproc/imgtrans/filter_2d/filter_2d.rst +++ b/doc/tutorials/imgproc/imgtrans/filter_2d/filter_2d.rst @@ -84,7 +84,7 @@ Code using namespace cv; - /** @function main */ + /* @function main */ int main ( int argc, char** argv ) { /// Declare variables diff --git a/doc/tutorials/imgproc/imgtrans/hough_circle/hough_circle.rst b/doc/tutorials/imgproc/imgtrans/hough_circle/hough_circle.rst index 3eb2e04e6a..8ca7992260 100644 --- a/doc/tutorials/imgproc/imgtrans/hough_circle/hough_circle.rst +++ b/doc/tutorials/imgproc/imgtrans/hough_circle/hough_circle.rst @@ -55,7 +55,7 @@ Code using namespace cv; - /** @function main */ + /* @function main */ int main(int argc, char** argv) { Mat src, src_gray; diff --git a/doc/tutorials/imgproc/imgtrans/laplace_operator/laplace_operator.rst b/doc/tutorials/imgproc/imgtrans/laplace_operator/laplace_operator.rst index 13bea48a01..911fe6b6f6 100644 --- a/doc/tutorials/imgproc/imgtrans/laplace_operator/laplace_operator.rst +++ b/doc/tutorials/imgproc/imgtrans/laplace_operator/laplace_operator.rst @@ -66,7 +66,7 @@ Code using namespace cv; - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { Mat src, src_gray, dst; diff --git a/doc/tutorials/imgproc/imgtrans/remap/remap.rst b/doc/tutorials/imgproc/imgtrans/remap/remap.rst index fad8443e22..9f5299cae2 100644 --- a/doc/tutorials/imgproc/imgtrans/remap/remap.rst +++ b/doc/tutorials/imgproc/imgtrans/remap/remap.rst @@ -79,7 +79,7 @@ Code /// Function Headers void update_map( void ); - /** + /* * @function main */ int main( int argc, char** argv ) @@ -114,7 +114,7 @@ Code return 0; } - /** + /* * @function update_map * @brief Fill the map_x and map_y matrices with 4 types of mappings */ diff --git a/doc/tutorials/imgproc/imgtrans/sobel_derivatives/sobel_derivatives.rst b/doc/tutorials/imgproc/imgtrans/sobel_derivatives/sobel_derivatives.rst index a7583780cf..9dd8475a4c 100644 --- a/doc/tutorials/imgproc/imgtrans/sobel_derivatives/sobel_derivatives.rst +++ b/doc/tutorials/imgproc/imgtrans/sobel_derivatives/sobel_derivatives.rst @@ -132,7 +132,7 @@ Code using namespace cv; - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { diff --git a/doc/tutorials/imgproc/imgtrans/warp_affine/warp_affine.rst b/doc/tutorials/imgproc/imgtrans/warp_affine/warp_affine.rst index 4717a5bbd6..8d4a29d000 100644 --- a/doc/tutorials/imgproc/imgtrans/warp_affine/warp_affine.rst +++ b/doc/tutorials/imgproc/imgtrans/warp_affine/warp_affine.rst @@ -110,7 +110,7 @@ Code char* warp_window = "Warp"; char* warp_rotate_window = "Warp + Rotate"; - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { Point2f srcTri[3]; @@ -141,7 +141,7 @@ Code /// Apply the Affine Transform just found to the src image warpAffine( src, warp_dst, warp_mat, warp_dst.size() ); - /** Rotating the image after Warp */ + /* Rotating the image after Warp */ /// Compute a rotation matrix with respect to the center of the image Point center = Point( warp_dst.cols/2, warp_dst.rows/2 ); diff --git a/doc/tutorials/imgproc/opening_closing_hats/opening_closing_hats.rst b/doc/tutorials/imgproc/opening_closing_hats/opening_closing_hats.rst index a807e9f2d8..facb077897 100644 --- a/doc/tutorials/imgproc/opening_closing_hats/opening_closing_hats.rst +++ b/doc/tutorials/imgproc/opening_closing_hats/opening_closing_hats.rst @@ -134,10 +134,10 @@ This tutorial code's is shown lines below. You can also download it from `here < char* window_name = "Morphology Transformations Demo"; - /** Function Headers */ + /* Function Headers */ void Morphology_Operations( int, void* ); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Load an image @@ -169,7 +169,7 @@ This tutorial code's is shown lines below. You can also download it from `here < return 0; } - /** + /* * @function Morphology_Operations */ void Morphology_Operations( int, void* ) @@ -227,7 +227,7 @@ Explanation .. code-block:: cpp - /** + /* * @function Morphology_Operations */ void Morphology_Operations( int, void* ) diff --git a/doc/tutorials/imgproc/pyramids/pyramids.rst b/doc/tutorials/imgproc/pyramids/pyramids.rst index 1d28ea46ef..a77f351b82 100644 --- a/doc/tutorials/imgproc/pyramids/pyramids.rst +++ b/doc/tutorials/imgproc/pyramids/pyramids.rst @@ -97,7 +97,7 @@ This tutorial code's is shown lines below. You can also download it from `here < char* window_name = "Pyramids Demo"; - /** + /* * @function main */ int main( int argc, char** argv ) diff --git a/doc/tutorials/imgproc/shapedescriptors/bounding_rects_circles/bounding_rects_circles.rst b/doc/tutorials/imgproc/shapedescriptors/bounding_rects_circles/bounding_rects_circles.rst index 66ee018eea..ed3eadd050 100644 --- a/doc/tutorials/imgproc/shapedescriptors/bounding_rects_circles/bounding_rects_circles.rst +++ b/doc/tutorials/imgproc/shapedescriptors/bounding_rects_circles/bounding_rects_circles.rst @@ -42,7 +42,7 @@ This tutorial code's is shown lines below. You can also download it from `here < /// Function header void thresh_callback(int, void* ); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Load source image and convert it to gray @@ -64,7 +64,7 @@ This tutorial code's is shown lines below. You can also download it from `here < return(0); } - /** @function thresh_callback */ + /* @function thresh_callback */ void thresh_callback(int, void* ) { Mat threshold_output; diff --git a/doc/tutorials/imgproc/shapedescriptors/bounding_rotated_ellipses/bounding_rotated_ellipses.rst b/doc/tutorials/imgproc/shapedescriptors/bounding_rotated_ellipses/bounding_rotated_ellipses.rst index 8e639fcf4a..12d00cea1a 100644 --- a/doc/tutorials/imgproc/shapedescriptors/bounding_rotated_ellipses/bounding_rotated_ellipses.rst +++ b/doc/tutorials/imgproc/shapedescriptors/bounding_rotated_ellipses/bounding_rotated_ellipses.rst @@ -42,7 +42,7 @@ This tutorial code's is shown lines below. You can also download it from `here < /// Function header void thresh_callback(int, void* ); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Load source image and convert it to gray @@ -64,7 +64,7 @@ This tutorial code's is shown lines below. You can also download it from `here < return(0); } - /** @function thresh_callback */ + /* @function thresh_callback */ void thresh_callback(int, void* ) { Mat threshold_output; diff --git a/doc/tutorials/imgproc/shapedescriptors/find_contours/find_contours.rst b/doc/tutorials/imgproc/shapedescriptors/find_contours/find_contours.rst index f3645e24d7..556f8913e1 100644 --- a/doc/tutorials/imgproc/shapedescriptors/find_contours/find_contours.rst +++ b/doc/tutorials/imgproc/shapedescriptors/find_contours/find_contours.rst @@ -40,7 +40,7 @@ This tutorial code's is shown lines below. You can also download it from `here < /// Function header void thresh_callback(int, void* ); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Load source image and convert it to gray @@ -62,7 +62,7 @@ This tutorial code's is shown lines below. You can also download it from `here < return(0); } - /** @function thresh_callback */ + /* @function thresh_callback */ void thresh_callback(int, void* ) { Mat canny_output; diff --git a/doc/tutorials/imgproc/shapedescriptors/hull/hull.rst b/doc/tutorials/imgproc/shapedescriptors/hull/hull.rst index 1f35a7c92e..81be2e5fb8 100644 --- a/doc/tutorials/imgproc/shapedescriptors/hull/hull.rst +++ b/doc/tutorials/imgproc/shapedescriptors/hull/hull.rst @@ -40,7 +40,7 @@ This tutorial code's is shown lines below. You can also download it from `here < /// Function header void thresh_callback(int, void* ); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Load source image and convert it to gray @@ -62,7 +62,7 @@ This tutorial code's is shown lines below. You can also download it from `here < return(0); } - /** @function thresh_callback */ + /* @function thresh_callback */ void thresh_callback(int, void* ) { Mat src_copy = src.clone(); diff --git a/doc/tutorials/imgproc/shapedescriptors/moments/moments.rst b/doc/tutorials/imgproc/shapedescriptors/moments/moments.rst index a77c6ea742..6f6090b545 100644 --- a/doc/tutorials/imgproc/shapedescriptors/moments/moments.rst +++ b/doc/tutorials/imgproc/shapedescriptors/moments/moments.rst @@ -42,7 +42,7 @@ This tutorial code's is shown lines below. You can also download it from `here < /// Function header void thresh_callback(int, void* ); - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Load source image and convert it to gray @@ -64,7 +64,7 @@ This tutorial code's is shown lines below. You can also download it from `here < return(0); } - /** @function thresh_callback */ + /* @function thresh_callback */ void thresh_callback(int, void* ) { Mat canny_output; diff --git a/doc/tutorials/imgproc/shapedescriptors/point_polygon_test/point_polygon_test.rst b/doc/tutorials/imgproc/shapedescriptors/point_polygon_test/point_polygon_test.rst index 836159c8e8..1adb251713 100644 --- a/doc/tutorials/imgproc/shapedescriptors/point_polygon_test/point_polygon_test.rst +++ b/doc/tutorials/imgproc/shapedescriptors/point_polygon_test/point_polygon_test.rst @@ -32,7 +32,7 @@ This tutorial code's is shown lines below. You can also download it from `here < using namespace cv; using namespace std; - /** @function main */ + /* @function main */ int main( int argc, char** argv ) { /// Create an image diff --git a/doc/tutorials/imgproc/threshold/threshold.rst b/doc/tutorials/imgproc/threshold/threshold.rst index 960f3b2c95..2395d387ea 100644 --- a/doc/tutorials/imgproc/threshold/threshold.rst +++ b/doc/tutorials/imgproc/threshold/threshold.rst @@ -158,7 +158,7 @@ The tutorial code's is shown lines below. You can also download it from `here - + diff --git a/doc/tutorials/objdetect/cascade_classifier/cascade_classifier.rst b/doc/tutorials/objdetect/cascade_classifier/cascade_classifier.rst index c5ceb9b829..7529157033 100644 --- a/doc/tutorials/objdetect/cascade_classifier/cascade_classifier.rst +++ b/doc/tutorials/objdetect/cascade_classifier/cascade_classifier.rst @@ -36,17 +36,17 @@ This tutorial code's is shown lines below. You can also download it from `here < using namespace std; using namespace cv; - /** Function Headers */ + /* Function Headers */ void detectAndDisplay( Mat frame ); - /** Global variables */ + /* Global variables */ String face_cascade_name = "haarcascade_frontalface_alt.xml"; String eyes_cascade_name = "haarcascade_eye_tree_eyeglasses.xml"; CascadeClassifier face_cascade; CascadeClassifier eyes_cascade; String window_name = "Capture - Face detection"; - /** @function main */ + /* @function main */ int main( void ) { VideoCapture capture; @@ -77,7 +77,7 @@ This tutorial code's is shown lines below. You can also download it from `here < return 0; } - /** @function detectAndDisplay */ + /* @function detectAndDisplay */ void detectAndDisplay( Mat frame ) { std::vector faces; diff --git a/doc/tutorials/viz/creating_widgets/creating_widgets.rst b/doc/tutorials/viz/creating_widgets/creating_widgets.rst index 4646d75194..6797122294 100644 --- a/doc/tutorials/viz/creating_widgets/creating_widgets.rst +++ b/doc/tutorials/viz/creating_widgets/creating_widgets.rst @@ -36,7 +36,7 @@ You can download the code from :download:`here <../../../../samples/cpp/tutorial using namespace cv; using namespace std; - /** + /* * @class WTriangle * @brief Defining our own 3D Triangle widget */ @@ -46,7 +46,7 @@ You can download the code from :download:`here <../../../../samples/cpp/tutorial WTriangle(const Point3f &pt1, const Point3f &pt2, const Point3f &pt3, const viz::Color & color = viz::Color::white()); }; - /** + /* * @function WTriangle::WTriangle */ WTriangle::WTriangle(const Point3f &pt1, const Point3f &pt2, const Point3f &pt3, const viz::Color & color) @@ -90,7 +90,7 @@ You can download the code from :download:`here <../../../../samples/cpp/tutorial setColor(color); } - /** + /* * @function main */ int main() diff --git a/doc/tutorials/viz/launching_viz/launching_viz.rst b/doc/tutorials/viz/launching_viz/launching_viz.rst index a507a7f27a..130419e164 100644 --- a/doc/tutorials/viz/launching_viz/launching_viz.rst +++ b/doc/tutorials/viz/launching_viz/launching_viz.rst @@ -28,7 +28,7 @@ You can download the code from :download:`here <../../../../samples/cpp/tutorial using namespace cv; using namespace std; - /** + /* * @function main */ int main() diff --git a/doc/tutorials/viz/transformations/transformations.rst b/doc/tutorials/viz/transformations/transformations.rst index e4d72c6f60..dcba40c1a4 100644 --- a/doc/tutorials/viz/transformations/transformations.rst +++ b/doc/tutorials/viz/transformations/transformations.rst @@ -28,7 +28,7 @@ You can download the code from :download:`here <../../../../samples/cpp/tutorial using namespace cv; using namespace std; - /** + /* * @function cvcloud_load * @brief load bunny.ply */ @@ -50,7 +50,7 @@ You can download the code from :download:`here <../../../../samples/cpp/tutorial return cloud; } - /** + /* * @function main */ int main(int argn, char **argv) diff --git a/doc/tutorials/viz/widget_pose/widget_pose.rst b/doc/tutorials/viz/widget_pose/widget_pose.rst index 08c612073a..626214b17b 100644 --- a/doc/tutorials/viz/widget_pose/widget_pose.rst +++ b/doc/tutorials/viz/widget_pose/widget_pose.rst @@ -28,7 +28,7 @@ You can download the code from :download:`here <../../../../samples/cpp/tutorial using namespace cv; using namespace std; - /** + /* * @function main */ int main()