Skip to content

calib3d: doc: remove C API link (For 4.x)#25141

Merged
asmorkalov merged 3 commits intoopencv:4.xfrom
Kumataro:fix25140_4.x
Mar 5, 2024
Merged

calib3d: doc: remove C API link (For 4.x)#25141
asmorkalov merged 3 commits intoopencv:4.xfrom
Kumataro:fix25140_4.x

Conversation

@Kumataro
Copy link
Copy Markdown
Contributor

@Kumataro Kumataro commented Mar 3, 2024

Related to #25140 (for 4.x)

Pull Request Readiness Checklist

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

  • I agree to contribute to the project under Apache 2 License.
  • To the best of my knowledge, the proposed patch is not based on a code under GPL or another license that is incompatible with OpenCV
  • The PR is proposed to the proper branch
  • There is a reference to the original bug report and related work
  • There is accuracy test, performance test and test data in opencv_extra repository, if applicable
    Patch to opencv_extra has the same branch name.
  • The feature is well documented and sample code can be built with the project CMake

@mshabunin mshabunin added the category: documentation Documentation fix or update label Mar 3, 2024
@asmorkalov asmorkalov added this to the 4.10.0 milestone Mar 3, 2024
@asmorkalov asmorkalov self-requested a review March 4, 2024 07:25
Copy link
Copy Markdown
Contributor

@asmorkalov asmorkalov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be removed too:

modules/calib3d/src/calib3d_c_api.h:54:/** @addtogroup calib3d_c
modules/calib3d/src/calib3d_c_api.h:419:/** @} calib3d_c */

@opencv-alalek
Copy link
Copy Markdown
Contributor

Removal is not enough. That stuff would appear in the common lists.

Need to replace to @cond IGNORED

@Kumataro
Copy link
Copy Markdown
Contributor Author

Kumataro commented Mar 4, 2024

Thank you for comment, I added @cond IGNORED as a precaution.

Probably, since only the include directories of each module are targeted in doc/CMakeList.txt, this file under src may not be targeted even before modification.

opencv/doc/CMakeLists.txt

Lines 167 to 169 in ef611df

# set export variables
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}")
string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_IMAGE_PATH "${doxygen_image_path}")

INPUT = @CMAKE_DOXYGEN_INPUT_LIST@

@mshabunin
Copy link
Copy Markdown
Contributor

modules/calib3d/src is not parsed by Doxygen, BTW.

Copy link
Copy Markdown
Contributor

@asmorkalov asmorkalov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@asmorkalov asmorkalov self-assigned this Mar 5, 2024
@asmorkalov asmorkalov merged commit b34ec57 into opencv:4.x Mar 5, 2024
@asmorkalov asmorkalov mentioned this pull request Mar 6, 2024
@asmorkalov asmorkalov mentioned this pull request Apr 1, 2024
klatism pushed a commit to klatism/opencv that referenced this pull request May 17, 2024
calib3d: doc: remove C API link (For 4.x) opencv#25141

Related to opencv#25140 (for 4.x)

### Pull Request Readiness Checklist

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

- [x] I agree to contribute to the project under Apache 2 License.
- [x] To the best of my knowledge, the proposed patch is not based on a code under GPL or another license that is incompatible with OpenCV
- [x] The PR is proposed to the proper branch
- [x] There is a reference to the original bug report and related work
- [ ] There is accuracy test, performance test and test data in opencv_extra repository, if applicable
      Patch to opencv_extra has the same branch name.
- [ ] The feature is well documented and sample code can be built with the project CMake
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants