[opencv] 69/71: fix documentation
Nobuhiro Iwamatsu
iwamatsu at moszumanska.debian.org
Mon Oct 17 20:16:31 UTC 2016
This is an automated email from the git hooks/post-receive script.
iwamatsu pushed a commit to annotated tag 2.4.13.1
in repository opencv.
commit 2d10336601ba026c29dcb5de08ffd641085a65ca
Author: Alexander Alekhin <alexander.alekhin at intel.com>
Date: Fri Sep 16 16:10:41 2016 +0300
fix documentation
---
README.md | 6 +++---
cmake/OpenCVDetectPython.cmake | 7 ++++---
doc/CMakeLists.txt | 4 +---
doc/conf.py | 2 +-
.../random_generator_and_text.rst | 2 +-
.../features2d/feature_detection/feature_detection.rst | 2 +-
.../feature_homography/feature_homography.rst | 2 +-
.../introduction/android_binary_package/O4A_SDK.rst | 6 +-----
.../android_binary_package/dev_with_OCV_on_Android.rst | 17 +++++++++--------
modules/contrib/doc/facerec/index.rst | 4 ----
samples/cpp/Qt_sample/qt_opengl.cpp | 2 +-
11 files changed, 23 insertions(+), 31 deletions(-)
diff --git a/README.md b/README.md
index e74a329..787b71f 100644
--- a/README.md
+++ b/README.md
@@ -3,13 +3,13 @@
#### Resources
* Homepage: <http://opencv.org>
-* Docs: <http://docs.opencv.org>
+* Docs: <http://docs.opencv.org/2.4/>
* Q&A forum: <http://answers.opencv.org>
-* Issue tracking: <http://code.opencv.org>
+* Issue tracking: <https://github.com/opencv/opencv/issues>
#### Contributing
-Please read before starting work on a pull request: <http://code.opencv.org/projects/opencv/wiki/How_to_contribute>
+Please read before starting work on a pull request: <https://github.com/opencv/opencv/wiki/How_to_contribute>
Summary of guidelines:
diff --git a/cmake/OpenCVDetectPython.cmake b/cmake/OpenCVDetectPython.cmake
index 7ef548f..20df69e 100644
--- a/cmake/OpenCVDetectPython.cmake
+++ b/cmake/OpenCVDetectPython.cmake
@@ -123,10 +123,11 @@ if(PYTHON_EXECUTABLE)
find_host_program(SPHINX_BUILD sphinx-build)
if(SPHINX_BUILD)
execute_process(COMMAND "${SPHINX_BUILD}"
- OUTPUT_QUIET
- ERROR_VARIABLE SPHINX_OUTPUT
+ ERROR_VARIABLE SPHINX_STDERR
+ OUTPUT_VARIABLE SPHINX_STDOUT
OUTPUT_STRIP_TRAILING_WHITESPACE)
- if(SPHINX_OUTPUT MATCHES "Sphinx v([0-9][^ \n]*)")
+ if(SPHINX_STDERR MATCHES "Sphinx v([0-9][^ \n]*)"
+ OR SPHINX_STDOUT MATCHES "Sphinx v([0-9][^ \n]*)")
set(SPHINX_VERSION "${CMAKE_MATCH_1}")
set(HAVE_SPHINX 1)
message(STATUS "Found Sphinx ${SPHINX_VERSION}: ${SPHINX_BUILD}")
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 66d2a47..29d5a0a 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -40,9 +40,7 @@ endif(HAVE_DOC_GENERATOR)
# ========= Sphinx docs =========
if(BUILD_DOCS AND HAVE_SPHINX)
- if(NOT INSTALL_CREATE_DISTRIB)
- list(APPEND DOC_LIST "${OpenCV_SOURCE_DIR}/doc/haartraining.htm")
- endif()
+ list(APPEND DOC_LIST "${OpenCV_SOURCE_DIR}/doc/haartraining.htm")
# build lists of documentation files and generate table of contents for reference manual
set(DOC_FAKE_ROOT "${CMAKE_CURRENT_BINARY_DIR}/fake-root")
diff --git a/doc/conf.py b/doc/conf.py
index 0bf75ad..430a835 100755
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -315,7 +315,7 @@ extlinks = {
# 'opencv_group' : ('http://answers.opencv.org/%s', None),
'opencv_qa' : ('http://answers.opencv.org/%s', None),
- 'how_to_contribute' : ('http://code.opencv.org/projects/opencv/wiki/How_to_contribute/%s', None),
+ 'how_to_contribute' : ('https://github.com/opencv/opencv/wiki/How_to_contribute/%s', None),
'cvt_color' : ('http://docs.opencv.org/modules/imgproc/doc/miscellaneous_transformations.html?highlight=cvtcolor#cvtcolor%s', None),
'imread' : ('http://docs.opencv.org/modules/highgui/doc/reading_and_writing_images_and_video.html?highlight=imread#imread%s', None),
diff --git a/doc/tutorials/core/random_generator_and_text/random_generator_and_text.rst b/doc/tutorials/core/random_generator_and_text/random_generator_and_text.rst
index a5c4bb7..3a743f9 100644
--- a/doc/tutorials/core/random_generator_and_text/random_generator_and_text.rst
+++ b/doc/tutorials/core/random_generator_and_text/random_generator_and_text.rst
@@ -22,7 +22,7 @@ Code
* 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* .
- * 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>`_ .
+ * 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>`_ .
Explanation
============
diff --git a/doc/tutorials/features2d/feature_detection/feature_detection.rst b/doc/tutorials/features2d/feature_detection/feature_detection.rst
index 51776de..e495d36 100644
--- a/doc/tutorials/features2d/feature_detection/feature_detection.rst
+++ b/doc/tutorials/features2d/feature_detection/feature_detection.rst
@@ -22,7 +22,7 @@ Theory
Code
====
-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>`_
+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>`_
.. code-block:: cpp
diff --git a/doc/tutorials/features2d/feature_homography/feature_homography.rst b/doc/tutorials/features2d/feature_homography/feature_homography.rst
index e195e53..def8759 100644
--- a/doc/tutorials/features2d/feature_homography/feature_homography.rst
+++ b/doc/tutorials/features2d/feature_homography/feature_homography.rst
@@ -20,7 +20,7 @@ Theory
Code
====
-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>`_
+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>`_
.. code-block:: cpp
diff --git a/doc/tutorials/introduction/android_binary_package/O4A_SDK.rst b/doc/tutorials/introduction/android_binary_package/O4A_SDK.rst
index f4d957f..8f7a2fb 100644
--- a/doc/tutorials/introduction/android_binary_package/O4A_SDK.rst
+++ b/doc/tutorials/introduction/android_binary_package/O4A_SDK.rst
@@ -48,11 +48,7 @@ The structure of package contents looks as follows:
::
- OpenCV-2.4.11-android-sdk
- |_ apk
- | |_ OpenCV_2.4.11_binary_pack_armv7a.apk
- | |_ OpenCV_2.4.11_Manager_2.20_XXX.apk
- |
+ OpenCV-2.4.13-android-sdk
|_ doc
|_ samples
|_ sdk
diff --git a/doc/tutorials/introduction/android_binary_package/dev_with_OCV_on_Android.rst b/doc/tutorials/introduction/android_binary_package/dev_with_OCV_on_Android.rst
index c83548e..7b9204e 100644
--- a/doc/tutorials/introduction/android_binary_package/dev_with_OCV_on_Android.rst
+++ b/doc/tutorials/introduction/android_binary_package/dev_with_OCV_on_Android.rst
@@ -55,14 +55,14 @@ Manager to access OpenCV libraries externally installed in the target system.
:guilabel:`File -> Import -> Existing project in your workspace`.
Press :guilabel:`Browse` button and locate OpenCV4Android SDK
- (:file:`OpenCV-2.4.11-android-sdk/sdk`).
+ (:file:`OpenCV-2.4.13-android-sdk/sdk`).
.. image:: images/eclipse_opencv_dependency0.png
:alt: Add dependency from OpenCV library
:align: center
#. In application project add a reference to the OpenCV Java SDK in
- :guilabel:`Project -> Properties -> Android -> Library -> Add` select ``OpenCV Library - 2.4.11``.
+ :guilabel:`Project -> Properties -> Android -> Library -> Add` select ``OpenCV Library - 2.4.13``.
.. image:: images/eclipse_opencv_dependency1.png
:alt: Add dependency from OpenCV library
@@ -128,27 +128,27 @@ described above.
#. Add the OpenCV library project to your workspace the same way as for the async initialization
above. Use menu :guilabel:`File -> Import -> Existing project in your workspace`,
press :guilabel:`Browse` button and select OpenCV SDK path
- (:file:`OpenCV-2.4.11-android-sdk/sdk`).
+ (:file:`OpenCV-2.4.13-android-sdk/sdk`).
.. image:: images/eclipse_opencv_dependency0.png
:alt: Add dependency from OpenCV library
:align: center
#. In the application project add a reference to the OpenCV4Android SDK in
- :guilabel:`Project -> Properties -> Android -> Library -> Add` select ``OpenCV Library - 2.4.11``;
+ :guilabel:`Project -> Properties -> Android -> Library -> Add` select ``OpenCV Library - 2.4.13``;
.. image:: images/eclipse_opencv_dependency1.png
:alt: Add dependency from OpenCV library
:align: center
#. If your application project **doesn't have a JNI part**, just copy the corresponding OpenCV
- native libs from :file:`<OpenCV-2.4.11-android-sdk>/sdk/native/libs/<target_arch>` to your
+ native libs from :file:`<OpenCV-2.4.13-android-sdk>/sdk/native/libs/<target_arch>` to your
project directory to folder :file:`libs/<target_arch>`.
In case of the application project **with a JNI part**, instead of manual libraries copying you
need to modify your ``Android.mk`` file:
add the following two code lines after the ``"include $(CLEAR_VARS)"`` and before
- ``"include path_to_OpenCV-2.4.11-android-sdk/sdk/native/jni/OpenCV.mk"``
+ ``"include path_to_OpenCV-2.4.13-android-sdk/sdk/native/jni/OpenCV.mk"``
.. code-block:: make
:linenos:
@@ -221,7 +221,7 @@ taken:
.. code-block:: make
- include C:\Work\OpenCV4Android\OpenCV-2.4.11-android-sdk\sdk\native\jni\OpenCV.mk
+ include C:\Work\OpenCV4Android\OpenCV-2.4.13-android-sdk\sdk\native\jni\OpenCV.mk
Should be inserted into the :file:`jni/Android.mk` file **after** this line:
@@ -230,7 +230,8 @@ taken:
include $(CLEAR_VARS)
#. Several variables can be used to customize OpenCV stuff, but you **don't need** to use them when
- your application uses the `async initialization` via the `OpenCV Manager` API.
+ your application uses the `async initialization` via the `OpenCV Manager` API
+ (It is not recommended since OpenCV 2.4.13).
.. note:: These variables should be set **before** the ``"include .../OpenCV.mk"`` line:
diff --git a/modules/contrib/doc/facerec/index.rst b/modules/contrib/doc/facerec/index.rst
index b871448..4605d7c 100644
--- a/modules/contrib/doc/facerec/index.rst
+++ b/modules/contrib/doc/facerec/index.rst
@@ -5,10 +5,6 @@ OpenCV 2.4 now comes with the very new :ocv:class:`FaceRecognizer` class for fac
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.
-Please issue any feature requests and/or bugs on the official OpenCV bug tracker at:
-
- * http://code.opencv.org/projects/opencv/issues
-
Contents
========
diff --git a/samples/cpp/Qt_sample/qt_opengl.cpp b/samples/cpp/Qt_sample/qt_opengl.cpp
index eebb17b..47b5478 100644
--- a/samples/cpp/Qt_sample/qt_opengl.cpp
+++ b/samples/cpp/Qt_sample/qt_opengl.cpp
@@ -30,7 +30,7 @@ static void help()
"Using OpenCV version " << CV_VERSION << "\n\n"
" 1) This demo is mainly based on work from Javier Barandiaran Martirena\n"
- " See this page http://code.opencv.org/projects/opencv/wiki/Posit.\n"
+ " See this page https://github.com/opencv/opencv/wiki/Posit .\n"
" 2) This is a demo to illustrate how to use **OpenGL Callback**.\n"
" 3) You need Qt binding to compile this sample with OpenGL support enabled.\n"
" 4) The features' detection is very basic and could highly be improved\n"
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/opencv.git
More information about the debian-science-commits
mailing list