Skip to content

Commit 2d10336

Browse files
alalekalalek
committed
fix documentation
1 parent 4d17051 commit 2d10336

File tree

11 files changed

+23
-31
lines changed

11 files changed

+23
-31
lines changed

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
#### Resources
44

55
* Homepage: <http://opencv.org>
6-
* Docs: <http://docs.opencv.org>
6+
* Docs: <http://docs.opencv.org/2.4/>
77
* Q&A forum: <http://answers.opencv.org>
8-
* Issue tracking: <http://code.opencv.org>
8+
* Issue tracking: <https://github.com/opencv/opencv/issues>
99

1010
#### Contributing
1111

12-
Please read before starting work on a pull request: <http://code.opencv.org/projects/opencv/wiki/How_to_contribute>
12+
Please read before starting work on a pull request: <https://github.com/opencv/opencv/wiki/How_to_contribute>
1313

1414
Summary of guidelines:
1515

‎cmake/OpenCVDetectPython.cmake

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,11 @@ if(PYTHON_EXECUTABLE)
123123
find_host_program(SPHINX_BUILD sphinx-build)
124124
if(SPHINX_BUILD)
125125
execute_process(COMMAND "${SPHINX_BUILD}"
126-
OUTPUT_QUIET
127-
ERROR_VARIABLE SPHINX_OUTPUT
126+
ERROR_VARIABLE SPHINX_STDERR
127+
OUTPUT_VARIABLE SPHINX_STDOUT
128128
OUTPUT_STRIP_TRAILING_WHITESPACE)
129-
if(SPHINX_OUTPUT MATCHES "Sphinx v([0-9][^ \n]*)")
129+
if(SPHINX_STDERR MATCHES "Sphinx v([0-9][^ \n]*)"
130+
OR SPHINX_STDOUT MATCHES "Sphinx v([0-9][^ \n]*)")
130131
set(SPHINX_VERSION "${CMAKE_MATCH_1}")
131132
set(HAVE_SPHINX 1)
132133
message(STATUS "Found Sphinx ${SPHINX_VERSION}: ${SPHINX_BUILD}")

‎doc/CMakeLists.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,7 @@ endif(HAVE_DOC_GENERATOR)
4040

4141
# ========= Sphinx docs =========
4242
if(BUILD_DOCS AND HAVE_SPHINX)
43-
if(NOT INSTALL_CREATE_DISTRIB)
44-
list(APPEND DOC_LIST "${OpenCV_SOURCE_DIR}/doc/haartraining.htm")
45-
endif()
43+
list(APPEND DOC_LIST "${OpenCV_SOURCE_DIR}/doc/haartraining.htm")
4644

4745
# build lists of documentation files and generate table of contents for reference manual
4846
set(DOC_FAKE_ROOT "${CMAKE_CURRENT_BINARY_DIR}/fake-root")

‎doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@
315315

316316
# 'opencv_group' : ('http://answers.opencv.org/%s', None),
317317
'opencv_qa' : ('http://answers.opencv.org/%s', None),
318-
'how_to_contribute' : ('http://code.opencv.org/projects/opencv/wiki/How_to_contribute/%s', None),
318+
'how_to_contribute' : ('https://github.com/opencv/opencv/wiki/How_to_contribute/%s', None),
319319

320320
'cvt_color' : ('http://docs.opencv.org/modules/imgproc/doc/miscellaneous_transformations.html?highlight=cvtcolor#cvtcolor%s', None),
321321
'imread' : ('http://docs.opencv.org/modules/highgui/doc/reading_and_writing_images_and_video.html?highlight=imread#imread%s', None),

‎doc/tutorials/core/random_generator_and_text/random_generator_and_text.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Code
2222

2323
* In this tutorial, we intend to use *random* values for the drawing parameters. Also, we intend to populate our image with a big number of geometric figures. Since we will be initializing them in a random fashion, this process will be automatic and made by using *loops* .
2424

25-
* This code is in your OpenCV sample folder. Otherwise you can grab it from `here <http://code.opencv.org/projects/opencv/repository/revisions/master/raw/samples/cpp/tutorial_code/core/Matrix/Drawing_2.cpp>`_ .
25+
* This code is in your OpenCV sample folder. Otherwise you can grab it from `here <https://github.com/opencv/opencv/blob/2.4/samples/cpp/tutorial_code/core/Matrix/Drawing_2.cpp>`_ .
2626

2727
Explanation
2828
============

‎doc/tutorials/features2d/feature_detection/feature_detection.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Theory
2222
Code
2323
====
2424

25-
This tutorial code's is shown lines below. You can also download it from `here <http://code.opencv.org/projects/opencv/repository/revisions/master/raw/samples/cpp/tutorial_code/features2D/SURF_detector.cpp>`_
25+
This tutorial code's is shown lines below. You can also download it from `here <https://github.com/opencv/opencv/blob/2.4/samples/cpp/tutorial_code/features2D/SURF_detector.cpp>`_
2626

2727
.. code-block:: cpp
2828

‎doc/tutorials/features2d/feature_homography/feature_homography.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Theory
2020
Code
2121
====
2222

23-
This tutorial code's is shown lines below. You can also download it from `here <http://code.opencv.org/projects/opencv/repository/revisions/master/raw/samples/cpp/tutorial_code/features2D/SURF_Homography.cpp>`_
23+
This tutorial code's is shown lines below. You can also download it from `here <https://github.com/opencv/opencv/blob/2.4/samples/cpp/tutorial_code/features2D/SURF_Homography.cpp>`_
2424

2525
.. code-block:: cpp
2626

‎doc/tutorials/introduction/android_binary_package/O4A_SDK.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,7 @@ The structure of package contents looks as follows:
4848

4949
::
5050

51-
OpenCV-2.4.11-android-sdk
52-
|_ apk
53-
| |_ OpenCV_2.4.11_binary_pack_armv7a.apk
54-
| |_ OpenCV_2.4.11_Manager_2.20_XXX.apk
55-
|
51+
OpenCV-2.4.13-android-sdk
5652
|_ doc
5753
|_ samples
5854
|_ sdk

‎doc/tutorials/introduction/android_binary_package/dev_with_OCV_on_Android.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,14 @@ Manager to access OpenCV libraries externally installed in the target system.
5555
:guilabel:`File -> Import -> Existing project in your workspace`.
5656

5757
Press :guilabel:`Browse` button and locate OpenCV4Android SDK
58-
(:file:`OpenCV-2.4.11-android-sdk/sdk`).
58+
(:file:`OpenCV-2.4.13-android-sdk/sdk`).
5959

6060
.. image:: images/eclipse_opencv_dependency0.png
6161
:alt: Add dependency from OpenCV library
6262
:align: center
6363

6464
#. In application project add a reference to the OpenCV Java SDK in
65-
:guilabel:`Project -> Properties -> Android -> Library -> Add` select ``OpenCV Library - 2.4.11``.
65+
:guilabel:`Project -> Properties -> Android -> Library -> Add` select ``OpenCV Library - 2.4.13``.
6666

6767
.. image:: images/eclipse_opencv_dependency1.png
6868
:alt: Add dependency from OpenCV library
@@ -128,27 +128,27 @@ described above.
128128
#. Add the OpenCV library project to your workspace the same way as for the async initialization
129129
above. Use menu :guilabel:`File -> Import -> Existing project in your workspace`,
130130
press :guilabel:`Browse` button and select OpenCV SDK path
131-
(:file:`OpenCV-2.4.11-android-sdk/sdk`).
131+
(:file:`OpenCV-2.4.13-android-sdk/sdk`).
132132

133133
.. image:: images/eclipse_opencv_dependency0.png
134134
:alt: Add dependency from OpenCV library
135135
:align: center
136136

137137
#. In the application project add a reference to the OpenCV4Android SDK in
138-
:guilabel:`Project -> Properties -> Android -> Library -> Add` select ``OpenCV Library - 2.4.11``;
138+
:guilabel:`Project -> Properties -> Android -> Library -> Add` select ``OpenCV Library - 2.4.13``;
139139

140140
.. image:: images/eclipse_opencv_dependency1.png
141141
:alt: Add dependency from OpenCV library
142142
:align: center
143143

144144
#. If your application project **doesn't have a JNI part**, just copy the corresponding OpenCV
145-
native libs from :file:`<OpenCV-2.4.11-android-sdk>/sdk/native/libs/<target_arch>` to your
145+
native libs from :file:`<OpenCV-2.4.13-android-sdk>/sdk/native/libs/<target_arch>` to your
146146
project directory to folder :file:`libs/<target_arch>`.
147147

148148
In case of the application project **with a JNI part**, instead of manual libraries copying you
149149
need to modify your ``Android.mk`` file:
150150
add the following two code lines after the ``"include $(CLEAR_VARS)"`` and before
151-
``"include path_to_OpenCV-2.4.11-android-sdk/sdk/native/jni/OpenCV.mk"``
151+
``"include path_to_OpenCV-2.4.13-android-sdk/sdk/native/jni/OpenCV.mk"``
152152

153153
.. code-block:: make
154154
:linenos:
@@ -221,7 +221,7 @@ taken:
221221

222222
.. code-block:: make
223223
224-
include C:\Work\OpenCV4Android\OpenCV-2.4.11-android-sdk\sdk\native\jni\OpenCV.mk
224+
include C:\Work\OpenCV4Android\OpenCV-2.4.13-android-sdk\sdk\native\jni\OpenCV.mk
225225
226226
Should be inserted into the :file:`jni/Android.mk` file **after** this line:
227227

@@ -230,7 +230,8 @@ taken:
230230
include $(CLEAR_VARS)
231231
232232
#. Several variables can be used to customize OpenCV stuff, but you **don't need** to use them when
233-
your application uses the `async initialization` via the `OpenCV Manager` API.
233+
your application uses the `async initialization` via the `OpenCV Manager` API
234+
(It is not recommended since OpenCV 2.4.13).
234235

235236
.. note:: These variables should be set **before** the ``"include .../OpenCV.mk"`` line:
236237

‎modules/contrib/doc/facerec/index.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ OpenCV 2.4 now comes with the very new :ocv:class:`FaceRecognizer` class for fac
55

66
These documents are the help I have wished for, when I was working myself into face recognition. I hope you also think the new :ocv:class:`FaceRecognizer` is a useful addition to OpenCV.
77

8-
Please issue any feature requests and/or bugs on the official OpenCV bug tracker at:
9-
10-
* http://code.opencv.org/projects/opencv/issues
11-
128
Contents
139
========
1410

0 commit comments

Comments
 (0)