Doxygen: replaced @includelineno by @include to enable copy-pasting

pull/3972/head
Philipp Hasper 10 years ago
parent 07e07655d4
commit dadf53f17c
  1. 2
      doc/tutorials/core/file_input_output_with_xml_yml/file_input_output_with_xml_yml.markdown
  2. 2
      doc/tutorials/core/how_to_use_ippa_conversion/how_to_use_ippa_conversion.markdown
  3. 2
      doc/tutorials/features2d/akaze_matching/akaze_matching.markdown
  4. 2
      doc/tutorials/features2d/akaze_tracking/akaze_tracking.markdown
  5. 2
      doc/tutorials/features2d/trackingmotion/generic_corner_detector/generic_corner_detector.markdown
  6. 2
      doc/tutorials/highgui/raster-gdal/raster_io_gdal.markdown
  7. 2
      doc/tutorials/highgui/video-input-psnr-ssim/video_input_psnr_ssim.markdown
  8. 2
      doc/tutorials/highgui/video-write/video_write.markdown
  9. 2
      doc/tutorials/imgproc/erosion_dilatation/erosion_dilatation.markdown
  10. 2
      doc/tutorials/imgproc/histograms/back_projection/back_projection.markdown
  11. 2
      doc/tutorials/imgproc/histograms/histogram_calculation/histogram_calculation.markdown
  12. 2
      doc/tutorials/imgproc/histograms/histogram_comparison/histogram_comparison.markdown
  13. 2
      doc/tutorials/imgproc/histograms/histogram_equalization/histogram_equalization.markdown
  14. 2
      doc/tutorials/imgproc/histograms/template_matching/template_matching.markdown
  15. 2
      doc/tutorials/imgproc/imgtrans/canny_detector/canny_detector.markdown
  16. 2
      doc/tutorials/imgproc/imgtrans/copyMakeBorder/copyMakeBorder.markdown
  17. 2
      doc/tutorials/imgproc/imgtrans/distance_transformation/distance_transform.markdown
  18. 2
      doc/tutorials/imgproc/imgtrans/hough_circle/hough_circle.markdown
  19. 2
      doc/tutorials/imgproc/imgtrans/hough_lines/hough_lines.markdown
  20. 2
      doc/tutorials/imgproc/imgtrans/laplace_operator/laplace_operator.markdown
  21. 2
      doc/tutorials/imgproc/imgtrans/remap/remap.markdown
  22. 2
      doc/tutorials/imgproc/imgtrans/sobel_derivatives/sobel_derivatives.markdown
  23. 2
      doc/tutorials/imgproc/imgtrans/warp_affine/warp_affine.markdown
  24. 2
      doc/tutorials/imgproc/morph_lines_detection/moprh_lines_detection.md
  25. 2
      doc/tutorials/imgproc/pyramids/pyramids.markdown
  26. 2
      doc/tutorials/imgproc/shapedescriptors/bounding_rects_circles/bounding_rects_circles.markdown
  27. 2
      doc/tutorials/imgproc/shapedescriptors/bounding_rotated_ellipses/bounding_rotated_ellipses.markdown
  28. 2
      doc/tutorials/imgproc/shapedescriptors/find_contours/find_contours.markdown
  29. 2
      doc/tutorials/imgproc/shapedescriptors/hull/hull.markdown
  30. 2
      doc/tutorials/imgproc/shapedescriptors/moments/moments.markdown
  31. 2
      doc/tutorials/imgproc/shapedescriptors/point_polygon_test/point_polygon_test.markdown
  32. 2
      doc/tutorials/imgproc/threshold/threshold.markdown
  33. 2
      doc/tutorials/introduction/display_image/display_image.markdown
  34. 3
      doc/tutorials/introduction/documenting_opencv/documentation_tutorial.markdown
  35. 2
      doc/tutorials/introduction/windows_visual_studio_Opencv/windows_visual_studio_Opencv.markdown
  36. 2
      doc/tutorials/ml/introduction_to_pca/introduction_to_pca.markdown
  37. 2
      doc/tutorials/ml/introduction_to_svm/introduction_to_svm.markdown
  38. 2
      doc/tutorials/ml/non_linear_svms/non_linear_svms.markdown
  39. 2
      doc/tutorials/photo/hdr_imaging/hdr_imaging.markdown
  40. 2
      doc/tutorials/video/background_subtraction/background_subtraction.markdown
  41. 2
      doc/tutorials/viz/creating_widgets/creating_widgets.markdown
  42. 2
      doc/tutorials/viz/launching_viz/launching_viz.markdown
  43. 2
      doc/tutorials/viz/transformations/transformations.markdown
  44. 2
      doc/tutorials/viz/widget_pose/widget_pose.markdown

@ -22,7 +22,7 @@ library.
Here's a sample code of how to achieve all the stuff enumerated at the goal list.
@includelineno cpp/tutorial_code/core/file_input_output/file_input_output.cpp
@include cpp/tutorial_code/core/file_input_output/file_input_output.cpp
Explanation
-----------

@ -18,7 +18,7 @@ You may also find the source code in the
`samples/cpp/tutorial_code/core/ippasync/ippasync_sample.cpp` file of the OpenCV source library or
download it from [here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/core/ippasync/ippasync_sample.cpp).
@includelineno cpp/tutorial_code/core/ippasync/ippasync_sample.cpp
@include cpp/tutorial_code/core/ippasync/ippasync_sample.cpp
Explanation
-----------

@ -31,7 +31,7 @@ You can find the images (*graf1.png*, *graf3.png*) and homography (*H1to3p.xml*)
### Source Code
@includelineno cpp/tutorial_code/features2D/AKAZE_match.cpp
@include cpp/tutorial_code/features2D/AKAZE_match.cpp
### Explanation

@ -36,7 +36,7 @@ To run the code you have to specify input and output video path and object bound
Source Code
-----------
@includelineno cpp/tutorial_code/features2D/AKAZE_tracking/planar_tracking.cpp
@include cpp/tutorial_code/features2D/AKAZE_tracking/planar_tracking.cpp
Explanation
-----------

@ -22,7 +22,7 @@ Code
This tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/TrackingMotion/cornerDetector_Demo.cpp)
@includelineno cpp/tutorial_code/TrackingMotion/cornerDetector_Demo.cpp
@include cpp/tutorial_code/TrackingMotion/cornerDetector_Demo.cpp
Explanation
-----------

@ -28,7 +28,7 @@ of the bay rise 10, 50, and 100 meters.
Code
----
@includelineno cpp/tutorial_code/HighGUI/GDAL_IO/gdal-image.cpp
@include cpp/tutorial_code/HighGUI/GDAL_IO/gdal-image.cpp
How to Read Raster Data using GDAL
----------------------------------

@ -25,7 +25,7 @@ version of it ](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutoria
You may also find the source code and these video file in the
`samples/cpp/tutorial_code/HighGUI/video-input-psnr-ssim/` folder of the OpenCV source library.
@includelineno cpp/tutorial_code/HighGUI/video-input-psnr-ssim/video-input-psnr-ssim.cpp
@include cpp/tutorial_code/HighGUI/video-input-psnr-ssim/video-input-psnr-ssim.cpp
How to read a video stream (online-camera or offline-file)?
-----------------------------------------------------------

@ -33,7 +33,7 @@ You may also find the source code and these video file in the
`samples/cpp/tutorial_code/highgui/video-write/` folder of the OpenCV source library or [download it
from here ](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/HighGUI/video-write/video-write.cpp).
@includelineno cpp/tutorial_code/HighGUI/video-write/video-write.cpp
@include cpp/tutorial_code/HighGUI/video-write/video-write.cpp
The structure of a video
------------------------

@ -61,7 +61,7 @@ Code
This tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgProc/Morphology_1.cpp)
@includelineno samples/cpp/tutorial_code/ImgProc/Morphology_1.cpp
@include samples/cpp/tutorial_code/ImgProc/Morphology_1.cpp
Explanation
-----------

@ -80,7 +80,7 @@ Code
in samples.
- **Code at glance:**
@includelineno samples/cpp/tutorial_code/Histograms_Matching/calcBackProject_Demo1.cpp
@include samples/cpp/tutorial_code/Histograms_Matching/calcBackProject_Demo1.cpp
Explanation
-----------

@ -68,7 +68,7 @@ Code
- **Downloadable code**: Click
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/Histograms_Matching/calcHist_Demo.cpp)
- **Code at glance:**
@includelineno samples/cpp/tutorial_code/Histograms_Matching/calcHist_Demo.cpp
@include samples/cpp/tutorial_code/Histograms_Matching/calcHist_Demo.cpp
Explanation
-----------

@ -47,7 +47,7 @@ Code
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/Histograms_Matching/compareHist_Demo.cpp)
- **Code at glance:**
@includelineno cpp/tutorial_code/Histograms_Matching/compareHist_Demo.cpp
@include cpp/tutorial_code/Histograms_Matching/compareHist_Demo.cpp
Explanation
-----------

@ -64,7 +64,7 @@ Code
- **Downloadable code**: Click
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/Histograms_Matching/EqualizeHist_Demo.cpp)
- **Code at glance:**
@includelineno samples/cpp/tutorial_code/Histograms_Matching/EqualizeHist_Demo.cpp
@include samples/cpp/tutorial_code/Histograms_Matching/EqualizeHist_Demo.cpp
Explanation
-----------

@ -98,7 +98,7 @@ Code
- **Downloadable code**: Click
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/Histograms_Matching/MatchTemplate_Demo.cpp)
- **Code at glance:**
@includelineno samples/cpp/tutorial_code/Histograms_Matching/MatchTemplate_Demo.cpp
@include samples/cpp/tutorial_code/Histograms_Matching/MatchTemplate_Demo.cpp
Explanation
-----------

@ -75,7 +75,7 @@ Code
-# The tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgTrans/CannyDetector_Demo.cpp)
@includelineno samples/cpp/tutorial_code/ImgTrans/CannyDetector_Demo.cpp
@include samples/cpp/tutorial_code/ImgTrans/CannyDetector_Demo.cpp
Explanation
-----------

@ -47,7 +47,7 @@ Code
-# The tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgTrans/copyMakeBorder_demo.cpp)
@includelineno samples/cpp/tutorial_code/ImgTrans/copyMakeBorder_demo.cpp
@include samples/cpp/tutorial_code/ImgTrans/copyMakeBorder_demo.cpp
Explanation
-----------

@ -18,7 +18,7 @@ Code
This tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgTrans/imageSegmentation.cpp).
@includelineno samples/cpp/tutorial_code/ImgTrans/imageSegmentation.cpp
@include samples/cpp/tutorial_code/ImgTrans/imageSegmentation.cpp
Explanation / Result
--------------------

@ -42,7 +42,7 @@ Code
-# The sample code that we will explain can be downloaded from [here](https://github.com/Itseez/opencv/tree/master/samples/cpp/houghcircles.cpp).
A slightly fancier version (which shows trackbars for
changing the threshold values) can be found [here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgTrans/HoughCircle_Demo.cpp).
@includelineno samples/cpp/houghcircles.cpp
@include samples/cpp/houghcircles.cpp
Explanation
-----------

@ -98,7 +98,7 @@ Code
-# The sample code that we will explain can be downloaded from [here](https://github.com/Itseez/opencv/tree/master/samples/cpp/houghlines.cpp). A slightly fancier version
(which shows both Hough standard and probabilistic with trackbars for changing the threshold
values) can be found [here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgTrans/HoughLines_Demo.cpp).
@includelineno samples/cpp/houghlines.cpp
@include samples/cpp/houghlines.cpp
Explanation
-----------

@ -52,7 +52,7 @@ Code
-# The tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgTrans/Laplace_Demo.cpp)
@includelineno samples/cpp/tutorial_code/ImgTrans/Laplace_Demo.cpp
@include samples/cpp/tutorial_code/ImgTrans/Laplace_Demo.cpp
Explanation
-----------

@ -53,7 +53,7 @@ Code
-# The tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgTrans/Remap_Demo.cpp)
@includelineno samples/cpp/tutorial_code/ImgTrans/Remap_Demo.cpp
@include samples/cpp/tutorial_code/ImgTrans/Remap_Demo.cpp
Explanation
-----------

@ -109,7 +109,7 @@ Code
-# The tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgTrans/Sobel_Demo.cpp)
@includelineno samples/cpp/tutorial_code/ImgTrans/Sobel_Demo.cpp
@include samples/cpp/tutorial_code/ImgTrans/Sobel_Demo.cpp
Explanation
-----------

@ -90,7 +90,7 @@ Code
-# The tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgTrans/Geometric_Transforms_Demo.cpp)
@includelineno samples/cpp/tutorial_code/ImgTrans/Geometric_Transforms_Demo.cpp
@include samples/cpp/tutorial_code/ImgTrans/Geometric_Transforms_Demo.cpp
Explanation
-----------

@ -49,7 +49,7 @@ Code
----
This tutorial code's is shown lines below. You can also download it from [here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgProc/Morphology_3.cpp).
@includelineno samples/cpp/tutorial_code/ImgProc/Morphology_3.cpp
@include samples/cpp/tutorial_code/ImgProc/Morphology_3.cpp
Explanation / Result
--------------------

@ -68,7 +68,7 @@ Code
This tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgProc/Pyramids.cpp)
@includelineno samples/cpp/tutorial_code/ImgProc/Pyramids.cpp
@include samples/cpp/tutorial_code/ImgProc/Pyramids.cpp
Explanation
-----------

@ -17,7 +17,7 @@ Code
This tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ShapeDescriptors/generalContours_demo1.cpp)
@includelineno samples/cpp/tutorial_code/ShapeDescriptors/generalContours_demo1.cpp
@include samples/cpp/tutorial_code/ShapeDescriptors/generalContours_demo1.cpp
Explanation
-----------

@ -17,7 +17,7 @@ Code
This tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ShapeDescriptors/generalContours_demo2.cpp)
@includelineno samples/cpp/tutorial_code/ShapeDescriptors/generalContours_demo2.cpp
@include samples/cpp/tutorial_code/ShapeDescriptors/generalContours_demo2.cpp
Explanation
-----------

@ -17,7 +17,7 @@ Code
This tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ShapeDescriptors/findContours_demo.cpp)
@includelineno samples/cpp/tutorial_code/ShapeDescriptors/findContours_demo.cpp
@include samples/cpp/tutorial_code/ShapeDescriptors/findContours_demo.cpp
Explanation
-----------

@ -17,7 +17,7 @@ Code
This tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ShapeDescriptors/hull_demo.cpp)
@includelineno samples/cpp/tutorial_code/ShapeDescriptors/hull_demo.cpp
@include samples/cpp/tutorial_code/ShapeDescriptors/hull_demo.cpp
Explanation
-----------

@ -18,7 +18,7 @@ Code
This tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ShapeDescriptors/moments_demo.cpp)
@includelineno samples/cpp/tutorial_code/ShapeDescriptors/moments_demo.cpp
@include samples/cpp/tutorial_code/ShapeDescriptors/moments_demo.cpp
Explanation
-----------

@ -16,7 +16,7 @@ Code
This tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ShapeDescriptors/pointPolygonTest_demo.cpp)
@includelineno samples/cpp/tutorial_code/ShapeDescriptors/pointPolygonTest_demo.cpp
@include samples/cpp/tutorial_code/ShapeDescriptors/pointPolygonTest_demo.cpp
Explanation
-----------

@ -98,7 +98,7 @@ Code
The tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ImgProc/Threshold.cpp)
@includelineno samples/cpp/tutorial_code/ImgProc/Threshold.cpp
@include samples/cpp/tutorial_code/ImgProc/Threshold.cpp
Explanation
-----------

@ -16,7 +16,7 @@ Source Code
Download the source code from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/introduction/display_image/display_image.cpp).
@includelineno cpp/tutorial_code/introduction/display_image/display_image.cpp
@include cpp/tutorial_code/introduction/display_image/display_image.cpp
Explanation
-----------

@ -415,7 +415,8 @@ you can manually specify it in curly braces:
To include whole example file into documentation, _include_ and _includelineno_ commands are used.
The file is searched in common samples locations, so you can specify just its name or short part of
the path. The _includelineno_ version also shows line numbers.
the path. The _includelineno_ version also shows line numbers but prevents copy-pasting since
the line numbers are included.
@verbatim
@include samples/cpp/test.cpp

@ -193,7 +193,7 @@ Now to try this out download our little test [source code
or get it from the sample code folder of the OpenCV sources. Add this to your project and build it.
Here's its content:
@includelineno cpp/tutorial_code/introduction/windows_visual_studio_Opencv/introduction_windows_vs.cpp
@include cpp/tutorial_code/introduction/windows_visual_studio_Opencv/introduction_windows_vs.cpp
You can start a Visual Studio build from two places. Either inside from the *IDE* (keyboard
combination: Control-F5) or by navigating to your build directory and start the application with a

@ -93,7 +93,7 @@ Source Code
This tutorial code's is shown lines below. You can also download it from
[here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ml/introduction_to_pca/introduction_to_pca.cpp).
@includelineno cpp/tutorial_code/ml/introduction_to_pca/introduction_to_pca.cpp
@include cpp/tutorial_code/ml/introduction_to_pca/introduction_to_pca.cpp
@note Another example using PCA for dimensionality reduction while maintaining an amount of variance can be found at [opencv_source_code/samples/cpp/pca.cpp](https://github.com/Itseez/opencv/tree/master/samples/cpp/pca.cpp)

@ -94,7 +94,7 @@ the weight vector \f$\beta\f$ and the bias \f$\beta_{0}\f$ of the optimal hyperp
Source Code
-----------
@includelineno cpp/tutorial_code/ml/introduction_to_svm/introduction_to_svm.cpp
@include cpp/tutorial_code/ml/introduction_to_svm/introduction_to_svm.cpp
Explanation
-----------

@ -89,7 +89,7 @@ Source Code
You may also find the source code in `samples/cpp/tutorial_code/ml/non_linear_svms` folder of the OpenCV source library or
[download it from here](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/ml/non_linear_svms/non_linear_svms.cpp).
@includelineno cpp/tutorial_code/ml/non_linear_svms/non_linear_svms.cpp
@include cpp/tutorial_code/ml/non_linear_svms/non_linear_svms.cpp
Explanation
-----------

@ -31,7 +31,7 @@ Exposure sequence
Source Code
-----------
@includelineno cpp/tutorial_code/photo/hdr_imaging/hdr_imaging.cpp
@include cpp/tutorial_code/photo/hdr_imaging/hdr_imaging.cpp
Explanation
-----------

@ -47,7 +47,7 @@ Two different methods are used to generate two foreground masks:
The results as well as the input data are shown on the screen.
The source file can be downloaded [here ](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/video/bg_sub.cpp).
@includelineno samples/cpp/tutorial_code/video/bg_sub.cpp
@include samples/cpp/tutorial_code/video/bg_sub.cpp
Explanation
-----------

@ -13,7 +13,7 @@ Code
----
You can download the code from [here ](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/viz/creating_widgets.cpp).
@includelineno samples/cpp/tutorial_code/viz/creating_widgets.cpp
@include samples/cpp/tutorial_code/viz/creating_widgets.cpp
Explanation
-----------

@ -15,7 +15,7 @@ Code
----
You can download the code from [here ](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/viz/launching_viz.cpp).
@includelineno samples/cpp/tutorial_code/viz/launching_viz.cpp
@include samples/cpp/tutorial_code/viz/launching_viz.cpp
Explanation
-----------

@ -14,7 +14,7 @@ Code
----
You can download the code from [here ](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/viz/transformations.cpp).
@includelineno samples/cpp/tutorial_code/viz/transformations.cpp
@include samples/cpp/tutorial_code/viz/transformations.cpp
Explanation
-----------

@ -14,7 +14,7 @@ Code
----
You can download the code from [here ](https://github.com/Itseez/opencv/tree/master/samples/cpp/tutorial_code/viz/widget_pose.cpp).
@includelineno samples/cpp/tutorial_code/viz/widget_pose.cpp
@include samples/cpp/tutorial_code/viz/widget_pose.cpp
Explanation
-----------

Loading…
Cancel
Save