comments in OpenCV source code
It is not a secret that OpenCV source code is poorly commented. So if one wants to dive deep into the source and understand, modify or speed it up it is hard to do. I plan to create a wiki where I would start painstakingly add comments (marked in a special way to distinguish them from original ones) to the most widely used modules/functions (without modifying the original code or comments). My question is whether somebody else has undertaken a similar effort? If not, what is a best way to do this? I currently got a domain and a wiki software and plan to organize it in such a way that crowdsourcing is easy and possible wrongdoing is minimized.
My current problems is to how provide a right color scheme for C++ and what is the best form to prevent users from modifying or shifting around the original code or comments. Currently, I consider keeping new comments separately in some kind of xml file (internally) that can be fused with original code. A wiki user will see it (externally) as a fused version where original code/comments are unavailable for editing.
that's goind to be hard. really hard. +1 anyway
Could you provide a particular example clarifying what you're going to do?
Point to some OpenCV function code and share what comments you'd like to add there.
here is a start: http://opencvcomment.com The files marked with red are in need of more comments
iVlad, are you going to merge your comments back to the OpenCV sources? If not, the whole project doesn't make much sense, because comment should be in the sources, right? If yes, who/when/how will merge newly added comments? I know the answer for the "who" part - OpenCV devs. But they accept only git patches or pull requests from the github. So, how often are you going to provide your patches with comments? How are you going to sync your wiki with changes in the OpenCV master?
eventually I will do it. But I wanted to ask you, why are you concerned about merging? I would be concerned with commenting itself since it will take 99% of the overall work. You see, the difference between system guys and computer vision guys is that they really think differently.
You know, I really appreciate your effort. I think it would be very useful to clarify some parts of the OpenCV code. And I really want to see your comments merged back to the code base. I'm just afraid that another OpenCV revolution may come and your comments may become irrelevant. For instance, OpenCV 2.5 is going to introduce micromodules, where old elephants like highgui and imgrpoc are going to be split into 2-4 micromodules. So, without regular merges 1% of the overall work may grow into exhaustive copy-pasting. And this may kill the whole initiative...