Ask Your Question
2

Lack of documentation

asked 2013-07-02 03:43:53 -0500

Roy gravatar image

Hi,

OpenCV is a large useful and complicated library and it is growing fast in size. However, many of the modules/functions which are being added are difficult/nearly impossible to use or understand due to the lack of basic documentation. I am talking about basic documentation and not exhaustive one. For instance, the stitching module, which is a large chunk of code, but very little documentation. What does the member variable indices_ in the stitcher class used for ? Perhaps it would be best to add more documentation regulations to contributed packages: 1. Reference to a relevant article/s for each algorithm. 2. For each variable use meaningful names ( variable "k" in a loop is meaningless). 3. Add a brief description of each function above that function, and a word or two near each member variable, and local variables. 4. Whenever it can help - add comments in the code.

This will make the OpenCV code much more readable and usable. After all, from what I understand the hard work put into OpenCV is meant to assist as many users as possible, and not to create an exclusive club of few people who actually understand what's going inside.... so I hope....

edit retag flag offensive close merge delete

Comments

3

If we would limit people in how they have to format their internal code when submitting new stuff, then the amount of submissions would drop even further. This is a open source software library with people using their spare time to devellop stuff, besides the basic staff that is behind the library. If you use the functionality provided, this is documented, even the papers used are documented, as seen here. Once you want to dive into code, you are on your own, using papers and your knowledge to analyse the provided code. I think the C++ API however is as clear as it can be, and docs are growing each day!

StevenPuttemans gravatar imageStevenPuttemans ( 2013-07-02 03:52:46 -0500 )edit

1 answer

Sort by ยป oldest newest most voted
4

answered 2013-07-03 07:27:16 -0500

AlexanderShishkov gravatar image

Thanks for the message! There are two ways to solve this problems: 1) OpenCV users should work more actively on documentation. This means that you can complete OpenCV documentation and send us pull-request with your update. 2) OpenCV users should donate our project more actively, that we can hire technical writer.

OpenCV it is non-commercial open source project, so we can't do all that is needed without your help or your donations.

edit flag offensive delete link more
Login/Signup to Answer

Question Tools

Stats

Asked: 2013-07-02 03:43:53 -0500

Seen: 196 times

Last updated: Jul 03 '13