opencv / opencv/opencv

Documentation: eliminate absolute paths

Open
#9,760 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

category: documentation
Dominant language
C++
Stars
90.9k
Forks
57k
Avg merge
2d 15h
Merged PRs (30d)
112

Description

Observed for classes from opencv_contrib.

Example:

The documentation for this class was generated from the following file:
/build/master-contrib_docs-lin64/opencv_contrib/modules/aruco/include/opencv2/aruco.hpp

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the documentation-generation path for classes from opencv_contrib and compare the linked cv::aruco::Board example with its generated source-file notice. Trace where the absolute build path is inserted. Done means generated documentation no longer exposes paths such as /build/master-contrib_docs-lin64/opencv_contrib/.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.