Skip to content

Commit d38869e

Browse files
committed
docs: fix links
- replace tutorial links via docs.opencv.org - remove link on OpenCV 2.4 - avoid links on outdated packages
1 parent ab21dc6 commit d38869e

File tree

12 files changed

+36
-44
lines changed

12 files changed

+36
-44
lines changed

doc/CMakeLists.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ if(DOXYGEN_FOUND)
3434
foreach(m ${OPENCV_MODULES_MAIN} ${OPENCV_MODULES_EXTRA})
3535
list(FIND blacklist ${m} _pos)
3636
if(${_pos} EQUAL -1)
37+
list(APPEND CMAKE_DOXYGEN_ENABLED_SECTIONS "HAVE_opencv_${m}")
3738
# include folder
3839
set(header_dir "${OPENCV_MODULE_opencv_${m}_LOCATION}/include")
3940
if(EXISTS "${header_dir}")
@@ -125,6 +126,8 @@ if(DOXYGEN_FOUND)
125126
# set export variables
126127
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}")
127128
string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_IMAGE_PATH "${paths_doc} ; ${tutorial_path} ; ${tutorial_py_path} ; ${tutorial_js_path} ; ${paths_tutorial}")
129+
string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_EXCLUDE_LIST "${CMAKE_DOXYGEN_EXCLUDE_LIST}")
130+
string(REPLACE ";" " " CMAKE_DOXYGEN_ENABLED_SECTIONS "${CMAKE_DOXYGEN_ENABLED_SECTIONS}")
128131
# TODO: remove paths_doc from EXAMPLE_PATH after face module tutorials/samples moved to separate folders
129132
string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_EXAMPLE_PATH "${example_path} ; ${paths_doc} ; ${paths_sample}")
130133
string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_INCLUDE_ROOTS "${paths_include}")

doc/Doxyfile.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ GENERATE_TODOLIST = YES
8585
GENERATE_TESTLIST = YES
8686
GENERATE_BUGLIST = YES
8787
GENERATE_DEPRECATEDLIST= YES
88-
ENABLED_SECTIONS =
88+
ENABLED_SECTIONS = @CMAKE_DOXYGEN_ENABLED_SECTIONS@
8989
MAX_INITIALIZER_LINES = 30
9090
SHOW_USED_FILES = YES
9191
SHOW_FILES = YES
@@ -104,7 +104,7 @@ INPUT = @CMAKE_DOXYGEN_INPUT_LIST@
104104
INPUT_ENCODING = UTF-8
105105
FILE_PATTERNS =
106106
RECURSIVE = YES
107-
EXCLUDE =
107+
EXCLUDE = @CMAKE_DOXYGEN_EXCLUDE_LIST@
108108
EXCLUDE_SYMLINKS = NO
109109
EXCLUDE_PATTERNS = *.inl.hpp *.impl.hpp *_detail.hpp */cudev/**/detail/*.hpp *.m */opencl/runtime/*
110110
EXCLUDE_SYMBOLS = cv::DataType<*> cv::traits::* int void CV__* T __CV*

doc/py_tutorials/py_imgproc/py_histograms/py_histogram_begins/py_histogram_begins.markdown

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@ you need 256 values to show the above histogram. But consider, what if you need
4141
of pixels for all pixel values separately, but number of pixels in a interval of pixel values? say
4242
for example, you need to find the number of pixels lying between 0 to 15, then 16 to 31, ..., 240 to 255.
4343
You will need only 16 values to represent the histogram. And that is what is shown in example
44-
given in [OpenCV Tutorials on
45-
histograms](http://docs.opencv.org/doc/tutorials/imgproc/histograms/histogram_calculation/histogram_calculation.html#histogram-calculation).
44+
given in @ref tutorial_histogram_calculation "OpenCV Tutorials on histograms".
4645

4746
So what you do is simply split the whole histogram to 16 sub-parts and value of each sub-part is the
4847
sum of all pixel count in it. This each sub-part is called "BIN". In first case, number of bins

doc/py_tutorials/py_setup/py_setup_in_windows/py_setup_in_windows.markdown

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@ Installing OpenCV from prebuilt binaries
1515

1616
-# Below Python packages are to be downloaded and installed to their default locations.
1717

18-
-# [Python-2.7.x](http://www.python.org/ftp/python/2.7.13/python-2.7.13.msi).
18+
-# Python 3.x (3.4+) or Python 2.7.x from [here](https://www.python.org/downloads/).
1919

20-
-# [Numpy](https://sourceforge.net/projects/numpy/files/NumPy/1.10.2/numpy-1.10.2-win32-superpack-python2.7.exe/download).
20+
-# Numpy package (for example, using `pip install numpy` command).
2121

22-
-# [Matplotlib](https://sourceforge.net/projects/matplotlib/files/matplotlib/matplotlib-1.5.0/windows/matplotlib-1.5.0.win32-py2.7.exe/download) (*Matplotlib is optional, but recommended since we use it a lot in our tutorials*).
22+
-# Matplotlib (`pip install matplotlib`) (*Matplotlib is optional, but recommended since we use it a lot in our tutorials*).
2323

24-
-# Install all packages into their default locations. Python will be installed to `C:/Python27/`.
24+
-# Install all packages into their default locations. Python will be installed to `C:/Python27/` in case of Python 2.7.
2525

2626
-# After installation, open Python IDLE. Enter **import numpy** and make sure Numpy is working fine.
2727

28-
-# Download latest OpenCV release from [sourceforge
29-
site](http://sourceforge.net/projects/opencvlibrary/files/opencv-win/2.4.6/OpenCV-2.4.6.0.exe/download)
28+
-# Download latest OpenCV release from [GitHub](https://github.com/opencv/opencv/releases) or
29+
[SourceForge site](https://sourceforge.net/projects/opencvlibrary/files/)
3030
and double-click to extract it.
3131

3232
-# Goto **opencv/build/python/2.7** folder.
@@ -49,16 +49,13 @@ Building OpenCV from source
4949

5050
-# [Visual Studio 2012](http://go.microsoft.com/?linkid=9816768)
5151

52-
-# [CMake](http://www.cmake.org/files/v2.8/cmake-2.8.11.2-win32-x86.exe)
52+
-# [CMake](https://cmake.org/download/)
5353

5454
-# Download and install necessary Python packages to their default locations
5555

56-
-# [Python 2.7.x](http://python.org/ftp/python/2.7.5/python-2.7.5.msi)
56+
-# Python
5757

58-
-# [Numpy](http://sourceforge.net/projects/numpy/files/NumPy/1.7.1/numpy-1.7.1-win32-superpack-python2.7.exe/download)
59-
60-
-# [Matplotlib](https://downloads.sourceforge.net/project/matplotlib/matplotlib/matplotlib-1.3.0/matplotlib-1.3.0.win32-py2.7.exe)
61-
(*Matplotlib is optional, but recommended since we use it a lot in our tutorials.*)
58+
-# Numpy
6259

6360
@note In this case, we are using 32-bit binaries of Python packages. But if you want to use
6461
OpenCV for x64, 64-bit binaries of Python packages are to be installed. Problem is that, there

doc/tutorials/calib3d/camera_calibration_pattern/camera_calibration_pattern.markdown

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,9 @@ If you want to change unit use -u option (mm inches, px, m)
3030

3131
If you want to change page size use -w and -h options
3232

33-
If you want to create a ChArUco board read tutorial Detection of ChArUco Corners in opencv_contrib tutorial(https://docs.opencv.org/3.4/df/d4a/tutorial_charuco_detection.html)
33+
@cond HAVE_opencv_aruco
34+
If you want to create a ChArUco board read @ref tutorial_charuco_detection "tutorial Detection of ChArUco Corners" in opencv_contrib tutorial.
35+
@endcond
36+
@cond !HAVE_opencv_aruco
37+
If you want to create a ChArUco board read tutorial Detection of ChArUco Corners in opencv_contrib tutorial.
38+
@endcond

doc/tutorials/gpu/gpu-basics-similarity/gpu_basics_similarity.markdown

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,7 @@ I1 = gI1; // Download, gI1.download(I1) will work too
9696
@endcode
9797
Once you have your data up in the GPU memory you may call GPU enabled functions of OpenCV. Most of
9898
the functions keep the same name just as on the CPU, with the difference that they only accept
99-
*GpuMat* inputs. A full list of these you will find in the documentation: [online
100-
here](http://docs.opencv.org/modules/gpu/doc/gpu.html) or the OpenCV reference manual that comes
101-
with the source code.
99+
*GpuMat* inputs.
102100

103101
Another thing to keep in mind is that not for all channel numbers you can make efficient algorithms
104102
on the GPU. Generally, I found that the input images for the GPU images need to be either one or

doc/tutorials/introduction/android_binary_package/O4A_SDK.markdown

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ The structure of package contents looks as follows:
8383

8484
- `doc` folder contains various OpenCV documentation in PDF format. It's also available online at
8585
<http://docs.opencv.org>.
86-
@note The most recent docs (nightly build) are at <http://docs.opencv.org/2.4>. Generally, it's more
86+
@note The most recent docs (nightly build) are at <http://docs.opencv.org/3.4>. Generally, it's more
8787
up-to-date, but can refer to not-yet-released functionality.
8888
@todo I'm not sure that this is the best place to talk about OpenCV Manager
8989

@@ -97,19 +97,15 @@ applications developers:
9797
- Automatic updates and bug fixes;
9898
- Trusted OpenCV library source. All packages with OpenCV are published on Google Play;
9999

100-
For additional information on OpenCV Manager see the:
101-
102-
- [Slides](https://docs.google.com/a/itseez.com/presentation/d/1EO_1kijgBg_BsjNp2ymk-aarg-0K279_1VZRcPplSuk/present#slide=id.p)
103-
- [Reference Manual](http://docs.opencv.org/android/refman.html)
104100

105101
Manual OpenCV4Android SDK setup
106102
-------------------------------
107103

108104
### Get the OpenCV4Android SDK
109105

110106
-# Go to the [OpenCV download page on
111-
SourceForge](http://sourceforge.net/projects/opencvlibrary/files/opencv-android/) and download
112-
the latest available version. Currently it's [OpenCV-2.4.9-android-sdk.zip](http://sourceforge.net/projects/opencvlibrary/files/opencv-android/2.4.9/OpenCV-2.4.9-android-sdk.zip/download).
107+
SourceForge](http://sourceforge.net/projects/opencvlibrary/files/) and download
108+
the latest available version. This tutorial is based on this package: [OpenCV-2.4.9-android-sdk.zip](http://sourceforge.net/projects/opencvlibrary/files/opencv-android/2.4.9/OpenCV-2.4.9-android-sdk.zip/download).
113109
-# Create a new folder for Android with OpenCV development. For this tutorial we have unpacked
114110
OpenCV SDK to the `C:\Work\OpenCV4Android\` directory.
115111

doc/tutorials/introduction/clojure_dev_intro/clojure_dev_intro.markdown

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ lein run
2727
Preamble
2828
--------
2929

30-
For detailed instruction on installing OpenCV with desktop Java support refer to the [corresponding
31-
tutorial](http://docs.opencv.org/2.4.4-beta/doc/tutorials/introduction/desktop_java/java_dev_intro.html).
30+
For detailed instruction on installing OpenCV with desktop Java support refer to the @ref tutorial_java_dev_intro "corresponding
31+
tutorial".
3232

3333
If you are in hurry, here is a minimum quick start guide to install OpenCV on Mac OS X:
3434

@@ -302,7 +302,7 @@ Then you can start interacting with OpenCV by just referencing the fully qualifi
302302
classes.
303303

304304
@note
305-
[Here](http://docs.opencv.org/java/) you can find the full OpenCV Java API.
305+
[Here](https://docs.opencv.org/3.4/javadoc/index.html) you can find the full OpenCV Java API.
306306

307307
@code{.clojure}
308308
user=> (org.opencv.core.Point. 0 0)
@@ -387,8 +387,7 @@ user=> (javadoc Rect)
387387
@endcode
388388
### Mimic the OpenCV Java Tutorial Sample in the REPL
389389

390-
Let's now try to port to Clojure the [opencv java tutorial
391-
sample](http://docs.opencv.org/2.4.4-beta/doc/tutorials/introduction/desktop_java/java_dev_intro.html).
390+
Let's now try to port to Clojure the @ref tutorial_java_dev_intro "OpenCV Java tutorial sample".
392391
Instead of writing it in a source file we're going to evaluate it at the REPL.
393392

394393
Following is the original Java source code of the cited sample.

doc/tutorials/ml/introduction_to_svm/introduction_to_svm.markdown

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,6 @@ the weight vector \f$\beta\f$ and the bias \f$\beta_{0}\f$ of the optimal hyperp
9494
Source Code
9595
-----------
9696

97-
@note The following code has been implemented with OpenCV 3.0 classes and functions. An equivalent version of the code using OpenCV 2.4 can be found in [this page.](http://docs.opencv.org/2.4/doc/tutorials/ml/introduction_to_svm/introduction_to_svm.html#introductiontosvms)
98-
9997
@add_toggle_cpp
10098
- **Downloadable code**: Click
10199
[here](https://github.com/opencv/opencv/tree/3.4/samples/cpp/tutorial_code/ml/introduction_to_svm/introduction_to_svm.cpp)

doc/tutorials/ml/non_linear_svms/non_linear_svms.markdown

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,6 @@ Source Code
8989
You may also find the source code in `samples/cpp/tutorial_code/ml/non_linear_svms` folder of the OpenCV source library or
9090
[download it from here](https://github.com/opencv/opencv/tree/3.4/samples/cpp/tutorial_code/ml/non_linear_svms/non_linear_svms.cpp).
9191

92-
@note The following code has been implemented with OpenCV 3.0 classes and functions. An equivalent version of the code
93-
using OpenCV 2.4 can be found in [this page.](http://docs.opencv.org/2.4/doc/tutorials/ml/non_linear_svms/non_linear_svms.html#nonlinearsvms)
94-
9592
@add_toggle_cpp
9693
- **Downloadable code**: Click
9794
[here](https://github.com/opencv/opencv/tree/3.4/samples/cpp/tutorial_code/ml/non_linear_svms/non_linear_svms.cpp)

0 commit comments

Comments
 (0)