Skip to content

Doc videoio enums#6734

Merged
opencv-pushbot merged 3 commits intoopencv:masterfrom
PkLab:doc_videoio_enums
Jul 1, 2016
Merged

Doc videoio enums#6734
opencv-pushbot merged 3 commits intoopencv:masterfrom
PkLab:doc_videoio_enums

Conversation

@PkLab
Copy link
Copy Markdown
Contributor

@PkLab PkLab commented Jun 27, 2016

resolves: Documenting the CAP_* enums in videoio.hpp

What does this PR change?

  • Current code comments for CAP_* enums have been converted in valid doxygen inline doc.
  • References to enums in VideoCapture and VideoWriter methods have been replaced by copydoc or auto linked (thanks to the fullname)
  • no changes in code (really CAP_FIREWIRE and CAP_FIREWARE have been switched in the list)

@PkLab
Copy link
Copy Markdown
Contributor Author

PkLab commented Jun 28, 2016 •
edited
Loading

May be @StevenPuttemans or @alalek might help me to solve this PR because I'm not sure I'm on the right way.

Point is that this PR was being in conflict with #6619 that has been merged later. So I've merged Itseez:master into PR:branch than solved the conflict with videoio.hpp.

In addiction 1 error checked by build bot in test_hal_core.cpp(185) but it seems not related to current changes...

any suggestions ?

@alalek
Copy link
Copy Markdown
Member

alalek commented Jun 28, 2016

This is sporadic failure. Build has been restarted.

@alalek
Copy link
Copy Markdown
Member

alalek commented Jun 29, 2016

Well done! Looks good to me.

@mshabunin
Copy link
Copy Markdown
Contributor

mshabunin commented Jun 29, 2016

I suggest naming all enumerations to make it possible to refer them from corresponding function documentation. See documentation for cv::imread for example.

@PkLab
Copy link
Copy Markdown
Contributor Author

PkLab commented Jun 29, 2016

@mshabunin I've this in my plan but I choose to make an atomic/simple PR as my 1st. If you want I can do this within this PR

@mshabunin
Copy link
Copy Markdown
Contributor

mshabunin commented Jun 29, 2016

@PkLab , ok then, lets merge this PR first.

@PkLab
Copy link
Copy Markdown
Contributor Author

PkLab commented Jun 29, 2016

@mshabunin Just opened a new issue #6746 about naming all enumerations

@apavlenko apavlenko self-assigned this Jul 1, 2016
@apavlenko
Copy link
Copy Markdown
Contributor

apavlenko commented Jul 1, 2016

👍

@opencv-pushbot opencv-pushbot merged commit adcdab3 into opencv:master Jul 1, 2016
opencv-pushbot pushed a commit that referenced this pull request Jul 1, 2016
Merge pull request #6734 from PkLab:doc_videoio_enums
330e4bb
@PkLab PkLab deleted the doc_videoio_enums branch July 1, 2016 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@apavlenko apavlenko

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@PkLab @alalek @mshabunin @apavlenko @opencv-pushbot