Skip to content

update ArUco Dictionary documentation#23914

Merged
asmorkalov merged 1 commit intoopencv:4.xfrom
AleksandrPanov:update_aruco_byteList_docs
Jul 13, 2023
Merged

update ArUco Dictionary documentation#23914
asmorkalov merged 1 commit intoopencv:4.xfrom
AleksandrPanov:update_aruco_byteList_docs

Conversation

@AleksandrPanov
Copy link
Copy Markdown
Contributor

@AleksandrPanov AleksandrPanov commented Jul 3, 2023

Improves documentation, issue 1939.

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

@AleksandrPanov AleksandrPanov force-pushed the update_aruco_byteList_docs branch 2 times, most recently from 264b0d1 to e5959be Compare July 3, 2023 23:44
asmorkalov
asmorkalov reviewed Jul 4, 2023
View reviewed changes
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.

  • Please add documentation to constructor. There is no need to duplicate byteList layout, just add reference to class implementation.
  • Fields of Dictionary are documented incorrectly. The comments are not included to doxygen generated documentation and IDE hints for Java/Python.

@asmorkalov asmorkalov force-pushed the update_aruco_byteList_docs branch from e5959be to c12e1ec Compare July 13, 2023 10:58
asmorkalov
asmorkalov approved these changes Jul 13, 2023
View reviewed changes
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 Jul 13, 2023
@asmorkalov asmorkalov added this to the 4.9.0 milestone Jul 13, 2023
@asmorkalov asmorkalov changed the title update ArUco bytesList docs update ArUco Dictionarry documentation Jul 13, 2023
@asmorkalov asmorkalov changed the title update ArUco Dictionarry documentation update ArUco Dictionary documentation Jul 13, 2023
@asmorkalov asmorkalov merged commit 3aeaa34 into opencv:4.x Jul 13, 2023
@asmorkalov asmorkalov mentioned this pull request Jul 27, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@asmorkalov asmorkalov asmorkalov approved these changes

Assignees

@asmorkalov asmorkalov

Labels

category: documentation Documentation fix or update category: objdetect

Projects

None yet

Milestone

4.9.0

Development

Successfully merging this pull request may close these issues.

2 participants

@AleksandrPanov @asmorkalov