Ask Your Question

Revision history [back]

click to hide/show revision 1
initial version

Released documentation (/3.0.0, /2.4.11, etc.) will not be modified in future, thus you can safely refer to it. Nightly documentation (/master, /2.4) is not as stable and will change.

Similar scheme applies to GitHub links:

  • good link: https://github.com/Itseez/opencv/blob/3.0.0/CMakeLists.txt#L10
  • good link: https://github.com/Itseez/opencv/blob/7323823b/CMakeLists.txt#L10
  • bad link: https://github.com/Itseez/opencv/blob/master/CMakeLists.txt#L10 - master branch changes over time and this path or line number can become invalid

Old doc urls (docs.opencv.org/modules/...) should be avoided, because they can become obsolete in future. Redirection has been made to keep most of the old links working.

As I understand Doxygen anchors depend on full function signature (void cv::circle(InputOutputArray img, Point center, ... )) and paths depend on group/page identifier (imgproc_draw).

Released documentation (/3.0.0, /2.4.11, etc.) will not be modified in future, thus you can safely refer to it. Nightly documentation (/master, /2.4) is not as stable and will change.

Similar scheme applies to GitHub links:

  • good link: https://github.com/Itseez/opencv/blob/3.0.0/CMakeLists.txt#L10
  • good link: https://github.com/Itseez/opencv/blob/7323823b/CMakeLists.txt#L10
  • bad link: https://github.com/Itseez/opencv/blob/master/CMakeLists.txt#L10 https://github.com/Itseez/opencv/blob/master/CMakeLists.txt#L10 - master branch changes over time and this path or line number can become invalid

Old doc urls (docs.opencv.org/modules/...) should be avoided, because they can become obsolete in future. Redirection has been made to keep most of the old links working.

As I understand Doxygen anchors depend on full function signature (void cv::circle(InputOutputArray img, Point center, ... )) and paths depend on group/page identifier (imgproc_draw).